Skip to content

Commit de5929e

Browse files
svc-excavator-botsvc-excavator-bot
authored
Excavator: Upgrade API Version (#216)
1 parent d40ea99 commit de5929e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

69 files changed

+4125
-62
lines changed

‎README.md‎

Lines changed: 62 additions & 0 deletions
Large diffs are not rendered by default.

‎docs-snippets-npm/package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
"sls": {
2525
"dependencies": {
2626
"com.palantir.foundry.api:api-gateway": {
27-
"minVersion": "1.1233.0",
27+
"minVersion": "1.1245.0",
2828
"maxVersion": "1.x.x",
2929
"optional": false
3030
}

‎docs-snippets-npm/src/index.ts‎

Lines changed: 53 additions & 3 deletions
Large diffs are not rendered by default.

‎docs/v1/Ontologies/models/OntologyInterfaceObjectSetType.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# OntologyInterfaceObjectSetType
2+
3+
OntologyInterfaceObjectSetType
4+
5+
## Properties
6+
| Name | Type | Required | Description |
7+
| ------------ | ------------- | ------------- | ------------- |
8+
**interface_type_api_name** | InterfaceTypeApiName | Yes | |
9+
**type** | Literal["interfaceObjectSet"] | Yes | None |
10+
11+
12+
[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md)

‎docs/v1/Ontologies/models/OntologyInterfaceObjectType.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ OntologyInterfaceObjectType
66
| Name | Type | Required | Description |
77
| ------------ | ------------- | ------------- | ------------- |
88
**interface_type_api_name** | Optional[InterfaceTypeApiName] | No | |
9-
**interface_type_rid** | Optional[InterfaceTypeRid] | No | |
109
**type** | Literal["interfaceObject"] | Yes | None |
1110

1211

‎docs/v1/Ontologies/models/QueryDataType.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ NullType | null
2929
QueryArrayType | array
3030
OntologyObjectSetType | objectSet
3131
TwoDimensionalAggregation | twoDimensionalAggregation
32+
OntologyInterfaceObjectSetType | interfaceObjectSet
3233
OntologyObjectType | object
3334
TimestampType | timestamp
3435

‎docs/v1/Ontologies/models/ValueTypeApiName.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# ValueTypeApiName
2+
3+
The name of the value type in the API in camelCase format.
4+
5+
## Type
6+
```python
7+
str
8+
```
9+
10+
11+
[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md)

‎docs/v1/Ontologies/models/ValueTypeRid.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# ValueTypeRid
2+
3+
ValueTypeRid
4+
5+
## Type
6+
```python
7+
RID
8+
```
9+
10+
11+
[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md)

‎docs/v2/Admin/EnrollmentRoleAssignment.md‎

Lines changed: 183 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,183 @@
1+
# EnrollmentRoleAssignment
2+
3+
Method | HTTP request | Release Stage |
4+
------------- | ------------- | ----- |
5+
[**add**](#add) | **POST** /v2/admin/enrollments/{enrollmentRid}/roleAssignments/add | Private Beta |
6+
[**list**](#list) | **GET** /v2/admin/enrollments/{enrollmentRid}/roleAssignments | Private Beta |
7+
[**remove**](#remove) | **POST** /v2/admin/enrollments/{enrollmentRid}/roleAssignments/remove | Private Beta |
8+
9+
# **add**
10+
Assign roles to principals for the given Enrollment. At most 100 role assignments can be added in a single request.
11+
12+
13+
### Parameters
14+
15+
Name | Type | Description | Notes |
16+
------------- | ------------- | ------------- | ------------- |
17+
**enrollment_rid** | EnrollmentRid | | |
18+
**role_assignments** | List[RoleAssignmentUpdate] | | |
19+
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |
20+
21+
### Return type
22+
**None**
23+
24+
### Example
25+
26+
```python
27+
from foundry_sdk import FoundryClient
28+
import foundry_sdk
29+
from pprint import pprint
30+
31+
client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")
32+
33+
# EnrollmentRid
34+
enrollment_rid = None
35+
# List[RoleAssignmentUpdate]
36+
role_assignments = [
37+
{
38+
"roleId": "8bf49052-dc37-4528-8bf0-b551cfb71268",
39+
"principalId": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
40+
}
41+
]
42+
# Optional[PreviewMode] | Enables the use of preview functionality.
43+
preview = None
44+
45+
46+
try:
47+
api_response = client.admin.Enrollment.EnrollmentRoleAssignment.add(
48+
enrollment_rid, role_assignments=role_assignments, preview=preview
49+
)
50+
print("The add response:\n")
51+
pprint(api_response)
52+
except foundry_sdk.PalantirRPCException as e:
53+
print("HTTP error when calling EnrollmentRoleAssignment.add: %s\n" % e)
54+
55+
```
56+
57+
58+
59+
### Authorization
60+
61+
See [README](../../../README.md#authorization)
62+
63+
### HTTP response details
64+
| Status Code | Type | Description | Content Type |
65+
|-------------|-------------|-------------|------------------|
66+
**204** | None | | None |
67+
68+
[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md)
69+
70+
# **list**
71+
List all principals who are assigned a role for the given Enrollment.
72+
73+
74+
### Parameters
75+
76+
Name | Type | Description | Notes |
77+
------------- | ------------- | ------------- | ------------- |
78+
**enrollment_rid** | EnrollmentRid | | |
79+
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |
80+
81+
### Return type
82+
**ListEnrollmentRoleAssignmentsResponse**
83+
84+
### Example
85+
86+
```python
87+
from foundry_sdk import FoundryClient
88+
import foundry_sdk
89+
from pprint import pprint
90+
91+
client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")
92+
93+
# EnrollmentRid
94+
enrollment_rid = None
95+
# Optional[PreviewMode] | Enables the use of preview functionality.
96+
preview = None
97+
98+
99+
try:
100+
api_response = client.admin.Enrollment.EnrollmentRoleAssignment.list(
101+
enrollment_rid, preview=preview
102+
)
103+
print("The list response:\n")
104+
pprint(api_response)
105+
except foundry_sdk.PalantirRPCException as e:
106+
print("HTTP error when calling EnrollmentRoleAssignment.list: %s\n" % e)
107+
108+
```
109+
110+
111+
112+
### Authorization
113+
114+
See [README](../../../README.md#authorization)
115+
116+
### HTTP response details
117+
| Status Code | Type | Description | Content Type |
118+
|-------------|-------------|-------------|------------------|
119+
**200** | ListEnrollmentRoleAssignmentsResponse | | application/json |
120+
121+
[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md)
122+
123+
# **remove**
124+
Remove roles from principals for the given Enrollment. At most 100 role assignments can be removed in a single request.
125+
126+
127+
### Parameters
128+
129+
Name | Type | Description | Notes |
130+
------------- | ------------- | ------------- | ------------- |
131+
**enrollment_rid** | EnrollmentRid | | |
132+
**role_assignments** | List[RoleAssignmentUpdate] | | |
133+
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |
134+
135+
### Return type
136+
**None**
137+
138+
### Example
139+
140+
```python
141+
from foundry_sdk import FoundryClient
142+
import foundry_sdk
143+
from pprint import pprint
144+
145+
client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")
146+
147+
# EnrollmentRid
148+
enrollment_rid = None
149+
# List[RoleAssignmentUpdate]
150+
role_assignments = [
151+
{
152+
"roleId": "8bf49052-dc37-4528-8bf0-b551cfb71268",
153+
"principalId": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
154+
}
155+
]
156+
# Optional[PreviewMode] | Enables the use of preview functionality.
157+
preview = None
158+
159+
160+
try:
161+
api_response = client.admin.Enrollment.EnrollmentRoleAssignment.remove(
162+
enrollment_rid, role_assignments=role_assignments, preview=preview
163+
)
164+
print("The remove response:\n")
165+
pprint(api_response)
166+
except foundry_sdk.PalantirRPCException as e:
167+
print("HTTP error when calling EnrollmentRoleAssignment.remove: %s\n" % e)
168+
169+
```
170+
171+
172+
173+
### Authorization
174+
175+
See [README](../../../README.md#authorization)
176+
177+
### HTTP response details
178+
| Status Code | Type | Description | Content Type |
179+
|-------------|-------------|-------------|------------------|
180+
**204** | None | | None |
181+
182+
[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md)
183+

‎docs/v2/Admin/Organization.md‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,80 @@
22

33
Method | HTTP request | Release Stage |
44
------------- | ------------- | ----- |
5+
[**create**](#create) | **POST** /v2/admin/organizations | Private Beta |
56
[**get**](#get) | **GET** /v2/admin/organizations/{organizationRid} | Public Beta |
67
[**list_available_roles**](#list_available_roles) | **GET** /v2/admin/organizations/{organizationRid}/listAvailableRoles | Public Beta |
78
[**replace**](#replace) | **PUT** /v2/admin/organizations/{organizationRid} | Public Beta |
89

10+
# **create**
11+
Creates a new Organization.
12+
13+
### Parameters
14+
15+
Name | Type | Description | Notes |
16+
------------- | ------------- | ------------- | ------------- |
17+
**administrators** | List[PrincipalId] | The initial administrators of the Organization. At least one principal must be provided. | |
18+
**enrollment_rid** | EnrollmentRid | The RID of the Enrollment that this Organization belongs to. This must be provided. | |
19+
**name** | OrganizationName | | |
20+
**description** | Optional[str] | | [optional] |
21+
**host** | Optional[HostName] | The primary host name of the Organization. This should be used when constructing URLs for users of this Organization. | [optional] |
22+
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |
23+
24+
### Return type
25+
**Organization**
26+
27+
### Example
28+
29+
```python
30+
from foundry_sdk import FoundryClient
31+
import foundry_sdk
32+
from pprint import pprint
33+
34+
client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")
35+
36+
# List[PrincipalId] | The initial administrators of the Organization. At least one principal must be provided.
37+
administrators = ["f05f8da4-b84c-4fca-9c77-8af0b13d11de"]
38+
# EnrollmentRid | The RID of the Enrollment that this Organization belongs to. This must be provided.
39+
enrollment_rid = "ri.control-panel.main.customer.466f812b-f974-4478-9d4f-90402cd3def6"
40+
# OrganizationName
41+
name = "Example Organization"
42+
# Optional[str]
43+
description = None
44+
# Optional[HostName] | The primary host name of the Organization. This should be used when constructing URLs for users of this Organization.
45+
host = "example.palantirfoundry.com"
46+
# Optional[PreviewMode] | Enables the use of preview functionality.
47+
preview = None
48+
49+
50+
try:
51+
api_response = client.admin.Organization.create(
52+
administrators=administrators,
53+
enrollment_rid=enrollment_rid,
54+
name=name,
55+
description=description,
56+
host=host,
57+
preview=preview,
58+
)
59+
print("The create response:\n")
60+
pprint(api_response)
61+
except foundry_sdk.PalantirRPCException as e:
62+
print("HTTP error when calling Organization.create: %s\n" % e)
63+
64+
```
65+
66+
67+
68+
### Authorization
69+
70+
See [README](../../../README.md#authorization)
71+
72+
### HTTP response details
73+
| Status Code | Type | Description | Content Type |
74+
|-------------|-------------|-------------|------------------|
75+
**200** | Organization | The created Organization | application/json |
76+
77+
[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md)
78+
979
# **get**
1080
Get the Organization with the specified rid.
1181

0 commit comments

Comments
 (0)