Skip to content

Commit 25f9d8c

Browse files
svc-excavator-botsvc-excavator-bot
authored
Excavator: Upgrade API Version (#199)
1 parent e5942a6 commit 25f9d8c

File tree

81 files changed

+2823
-211
lines changed

Some content is hidden

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

81 files changed

+2823
-211
lines changed

‎README.md‎

Lines changed: 60 additions & 2 deletions
Large diffs are not rendered by default.

‎docs-snippets-npm/package.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@
1818
"homepage": "https://github.com/palantir/foundry-platform-python#readme",
1919
"devDependencies": {
2020
"@osdk/docs-spec-core": "^0.5.0",
21-
"@osdk/platform-docs-spec": "^0.6.0",
21+
"@osdk/docs-spec-platform": "^0.8.0",
2222
"typescript": "^5.8.3"
2323
},
2424
"sls": {
2525
"dependencies": {
2626
"com.palantir.foundry.api:api-gateway": {
27-
"minVersion": "1.1163.0",
27+
"minVersion": "1.1174.0",
2828
"maxVersion": "1.x.x",
2929
"optional": false
3030
}

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

Lines changed: 33 additions & 8 deletions
Large diffs are not rendered by default.

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

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# PropertyTypeRid
2+
3+
PropertyTypeRid
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/v1/Ontologies/models/SdkPackageRid.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# SdkPackageRid
2+
3+
SdkPackageRid
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/v1/Ontologies/models/SdkVersion.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# SdkVersion
2+
3+
SdkVersion
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/v2/Admin/Organization.md‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
Method | HTTP request | Release Stage |
44
------------- | ------------- | ----- |
55
[**get**](#get) | **GET** /v2/admin/organizations/{organizationRid} | Public Beta |
6+
[**list_available_roles**](#list_available_roles) | **GET** /v2/admin/organizations/{organizationRid}/listAvailableRoles | Public Beta |
67
[**replace**](#replace) | **PUT** /v2/admin/organizations/{organizationRid} | Public Beta |
78

89
# **get**
@@ -55,6 +56,57 @@ See [README](../../../README.md#authorization)
5556

5657
[[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)
5758

59+
# **list_available_roles**
60+
List all roles that can be assigned to a principal for the given Organization.
61+
62+
63+
### Parameters
64+
65+
Name | Type | Description | Notes |
66+
------------- | ------------- | ------------- | ------------- |
67+
**organization_rid** | OrganizationRid | | |
68+
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |
69+
70+
### Return type
71+
**ListAvailableOrganizationRolesResponse**
72+
73+
### Example
74+
75+
```python
76+
from foundry_sdk import FoundryClient
77+
import foundry_sdk
78+
from pprint import pprint
79+
80+
client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")
81+
82+
# OrganizationRid
83+
organization_rid = None
84+
# Optional[PreviewMode] | Enables the use of preview functionality.
85+
preview = None
86+
87+
88+
try:
89+
api_response = client.admin.Organization.list_available_roles(organization_rid, preview=preview)
90+
print("The list_available_roles response:\n")
91+
pprint(api_response)
92+
except foundry_sdk.PalantirRPCException as e:
93+
print("HTTP error when calling Organization.list_available_roles: %s\n" % e)
94+
95+
```
96+
97+
98+
99+
### Authorization
100+
101+
See [README](../../../README.md#authorization)
102+
103+
### HTTP response details
104+
| Status Code | Type | Description | Content Type |
105+
|-------------|-------------|-------------|------------------|
106+
**200** | ListAvailableOrganizationRolesResponse | | application/json |
107+
108+
[[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)
109+
58110
# **replace**
59111
Replace the Organization with the specified rid.
60112

‎docs/v2/Admin/OrganizationRoleAssignment.md‎

Lines changed: 183 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,183 @@
1+
# OrganizationRoleAssignment
2+
3+
Method | HTTP request | Release Stage |
4+
------------- | ------------- | ----- |
5+
[**add**](#add) | **POST** /v2/admin/organizations/{organizationRid}/roleAssignments/add | Public Beta |
6+
[**list**](#list) | **GET** /v2/admin/organizations/{organizationRid}/roleAssignments | Public Beta |
7+
[**remove**](#remove) | **POST** /v2/admin/organizations/{organizationRid}/roleAssignments/remove | Public Beta |
8+
9+
# **add**
10+
Assign roles to principals for the given Organization. At most 100 role assignments can be added in a single request.
11+
12+
13+
### Parameters
14+
15+
Name | Type | Description | Notes |
16+
------------- | ------------- | ------------- | ------------- |
17+
**organization_rid** | OrganizationRid | | |
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+
# OrganizationRid
34+
organization_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.Organization.OrganizationRoleAssignment.add(
48+
organization_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 OrganizationRoleAssignment.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 Organization.
72+
73+
74+
### Parameters
75+
76+
Name | Type | Description | Notes |
77+
------------- | ------------- | ------------- | ------------- |
78+
**organization_rid** | OrganizationRid | | |
79+
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |
80+
81+
### Return type
82+
**ListOrganizationRoleAssignmentsResponse**
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+
# OrganizationRid
94+
organization_rid = None
95+
# Optional[PreviewMode] | Enables the use of preview functionality.
96+
preview = None
97+
98+
99+
try:
100+
api_response = client.admin.Organization.OrganizationRoleAssignment.list(
101+
organization_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 OrganizationRoleAssignment.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** | ListOrganizationRoleAssignmentsResponse | | 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 Organization. At most 100 role assignments can be removed in a single request.
125+
126+
127+
### Parameters
128+
129+
Name | Type | Description | Notes |
130+
------------- | ------------- | ------------- | ------------- |
131+
**organization_rid** | OrganizationRid | | |
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+
# OrganizationRid
148+
organization_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.Organization.OrganizationRoleAssignment.remove(
162+
organization_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 OrganizationRoleAssignment.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/models/ListAvailableOrganizationRolesResponse.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# ListAvailableOrganizationRolesResponse
2+
3+
ListAvailableOrganizationRolesResponse
4+
5+
## Properties
6+
| Name | Type | Required | Description |
7+
| ------------ | ------------- | ------------- | ------------- |
8+
**data** | List[Role] | Yes | |
9+
10+
11+
[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md)

‎docs/v2/Admin/models/ListOrganizationRoleAssignmentsResponse.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# ListOrganizationRoleAssignmentsResponse
2+
3+
ListOrganizationRoleAssignmentsResponse
4+
5+
## Properties
6+
| Name | Type | Required | Description |
7+
| ------------ | ------------- | ------------- | ------------- |
8+
**data** | List[OrganizationRoleAssignment] | Yes | |
9+
**next_page_token** | Optional[PageToken] | No | |
10+
11+
12+
[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md)

0 commit comments

Comments
 (0)