Skip to content

Commit 93f26ac

Browse files
svc-excavator-botsvc-excavator-bot
committed
Excavator: Upgrade API Version
1 parent e2841fe commit 93f26ac

78 files changed

Lines changed: 2098 additions & 387 deletions

File tree

Some content is hidden

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

‎README.md‎

Lines changed: 39 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.1497.0",
27+
"minVersion": "1.1510.0",
2828
"maxVersion": "1.x.x",
2929
"optional": false
3030
}

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

Lines changed: 36 additions & 16 deletions
Large diffs are not rendered by default.

‎docs/v2/Admin/AuthenticationProvider.md‎

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -223,17 +223,7 @@ organization = "ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa"
223223
# UserUsername | The new user's username. This must match one of the provider's supported username patterns.
224224
username = "jsmith"
225225
# Optional[Dict[AttributeName, AttributeValues]]
226-
attributes = {
227-
"multipass:givenName": ["John"],
228-
"multipass:familyName": ["Smith"],
229-
"multipass:email:primary": ["jsmith@example.com"],
230-
"multipass:realm": ["eab0a251-ca1a-4a84-a482-200edfb8026f"],
231-
"multipass:organization-rid": [
232-
"ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa"
233-
],
234-
"department": ["Finance"],
235-
"jobTitle": ["Accountant"],
236-
}
226+
attributes = {"department": ["Finance"], "jobTitle": ["Accountant"]}
237227
# Optional[str]
238228
email = "jsmith@example.com"
239229
# Optional[str]

‎docs/v2/Admin/CbacBanner.md‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# CbacBanner
2+
3+
Method | HTTP request | Release Stage |
4+
------------- | ------------- | ----- |
5+
[**get**](#get) | **GET** /v2/admin/cbacBanner | Public Beta |
6+
7+
# **get**
8+
Returns a classification banner string and colors for the given set of marking IDs.
9+
10+
### Parameters
11+
12+
Name | Type | Description | Notes |
13+
------------- | ------------- | ------------- | ------------- |
14+
**display_type** | Optional[ClassificationBannerDisplayType] | The display type of the banner. Defaults to PORTION_MARKING. | [optional] |
15+
**marking_ids** | Optional[List[MarkingId]] | The marking IDs for which to generate a banner. | [optional] |
16+
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |
17+
18+
### Return type
19+
**CbacBanner**
20+
21+
### Example
22+
23+
```python
24+
from foundry_sdk import FoundryClient
25+
import foundry_sdk
26+
from pprint import pprint
27+
28+
client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")
29+
30+
# Optional[ClassificationBannerDisplayType] | The display type of the banner. Defaults to PORTION_MARKING.
31+
display_type = None
32+
# Optional[List[MarkingId]] | The marking IDs for which to generate a banner.
33+
marking_ids = None
34+
# Optional[PreviewMode] | Enables the use of preview functionality.
35+
preview = None
36+
37+
38+
try:
39+
api_response = client.admin.CbacBanner.get(
40+
display_type=display_type, marking_ids=marking_ids, preview=preview
41+
)
42+
print("The get response:\n")
43+
pprint(api_response)
44+
except foundry_sdk.PalantirRPCException as e:
45+
print("HTTP error when calling CbacBanner.get: %s\n" % e)
46+
47+
```
48+
49+
50+
51+
### Authorization
52+
53+
See [README](../../../README.md#authorization)
54+
55+
### HTTP response details
56+
| Status Code | Type | Description | Content Type |
57+
|-------------|-------------|-------------|------------------|
58+
**200** | CbacBanner | | application/json |
59+
60+
[[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)
61+

‎docs/v2/Admin/CbacMarkingRestrictions.md‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# CbacMarkingRestrictions
2+
3+
Method | HTTP request | Release Stage |
4+
------------- | ------------- | ----- |
5+
[**get**](#get) | **GET** /v2/admin/cbacMarkingRestrictions | Public Beta |
6+
7+
# **get**
8+
Returns disallowed, implied, and required markings for the given set of marking IDs.
9+
10+
### Parameters
11+
12+
Name | Type | Description | Notes |
13+
------------- | ------------- | ------------- | ------------- |
14+
**marking_ids** | Optional[List[MarkingId]] | The marking IDs for which to get restrictions. | [optional] |
15+
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |
16+
17+
### Return type
18+
**CbacMarkingRestrictions**
19+
20+
### Example
21+
22+
```python
23+
from foundry_sdk import FoundryClient
24+
import foundry_sdk
25+
from pprint import pprint
26+
27+
client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")
28+
29+
# Optional[List[MarkingId]] | The marking IDs for which to get restrictions.
30+
marking_ids = None
31+
# Optional[PreviewMode] | Enables the use of preview functionality.
32+
preview = None
33+
34+
35+
try:
36+
api_response = client.admin.CbacMarkingRestrictions.get(
37+
marking_ids=marking_ids, preview=preview
38+
)
39+
print("The get response:\n")
40+
pprint(api_response)
41+
except foundry_sdk.PalantirRPCException as e:
42+
print("HTTP error when calling CbacMarkingRestrictions.get: %s\n" % e)
43+
44+
```
45+
46+
47+
48+
### Authorization
49+
50+
See [README](../../../README.md#authorization)
51+
52+
### HTTP response details
53+
| Status Code | Type | Description | Content Type |
54+
|-------------|-------------|-------------|------------------|
55+
**200** | CbacMarkingRestrictions | | application/json |
56+
57+
[[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)
58+

‎docs/v2/Admin/Enrollment.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
Method | HTTP request | Release Stage |
44
------------- | ------------- | ----- |
5-
[**get**](#get) | **GET** /v2/admin/enrollments/{enrollmentRid} | Private Beta |
6-
[**get_current**](#get_current) | **GET** /v2/admin/enrollments/getCurrent | Private Beta |
5+
[**get**](#get) | **GET** /v2/admin/enrollments/{enrollmentRid} | Public Beta |
6+
[**get_current**](#get_current) | **GET** /v2/admin/enrollments/getCurrent | Public Beta |
77

88
# **get**
99
Get the Enrollment with the specified rid.

‎docs/v2/Admin/EnrollmentRoleAssignment.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
Method | HTTP request | Release Stage |
44
------------- | ------------- | ----- |
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 |
5+
[**add**](#add) | **POST** /v2/admin/enrollments/{enrollmentRid}/roleAssignments/add | Public Beta |
6+
[**list**](#list) | **GET** /v2/admin/enrollments/{enrollmentRid}/roleAssignments | Public Beta |
7+
[**remove**](#remove) | **POST** /v2/admin/enrollments/{enrollmentRid}/roleAssignments/remove | Public Beta |
88

99
# **add**
1010
Assign roles to principals for the given Enrollment. At most 100 role assignments can be added in a single request.

‎docs/v2/Admin/GroupProviderInfo.md‎

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
Method | HTTP request | Release Stage |
44
------------- | ------------- | ----- |
5-
[**get**](#get) | **GET** /v2/admin/groups/{groupId}/providerInfo | Public Beta |
6-
[**replace**](#replace) | **PUT** /v2/admin/groups/{groupId}/providerInfo | Public Beta |
5+
[**get**](#get) | **GET** /v2/admin/groups/{groupId}/providerInfo | Stable |
6+
[**replace**](#replace) | **PUT** /v2/admin/groups/{groupId}/providerInfo | Stable |
77

88
# **get**
99
Get the GroupProviderInfo.
@@ -13,7 +13,6 @@ Get the GroupProviderInfo.
1313
Name | Type | Description | Notes |
1414
------------- | ------------- | ------------- | ------------- |
1515
**group_id** | GroupId | | |
16-
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |
1716

1817
### Return type
1918
**GroupProviderInfo**
@@ -29,12 +28,10 @@ client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.pa
2928

3029
# GroupId
3130
group_id = None
32-
# Optional[PreviewMode] | Enables the use of preview functionality.
33-
preview = None
3431

3532

3633
try:
37-
api_response = client.admin.Group.ProviderInfo.get(group_id, preview=preview)
34+
api_response = client.admin.Group.ProviderInfo.get(group_id)
3835
print("The get response:\n")
3936
pprint(api_response)
4037
except foundry_sdk.PalantirRPCException as e:
@@ -64,7 +61,6 @@ Name | Type | Description | Notes |
6461
------------- | ------------- | ------------- | ------------- |
6562
**group_id** | GroupId | | |
6663
**provider_id** | ProviderId | The ID of the Group in the external authentication provider. This value is determined by the authentication provider. At most one Group can have a given provider ID in a given Realm. | |
67-
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |
6864

6965
### Return type
7066
**GroupProviderInfo**
@@ -82,14 +78,10 @@ client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.pa
8278
group_id = None
8379
# ProviderId | The ID of the Group in the external authentication provider. This value is determined by the authentication provider. At most one Group can have a given provider ID in a given Realm.
8480
provider_id = "2838c8f3-d76a-4e99-acf1-1dee537e4c48"
85-
# Optional[PreviewMode] | Enables the use of preview functionality.
86-
preview = None
8781

8882

8983
try:
90-
api_response = client.admin.Group.ProviderInfo.replace(
91-
group_id, provider_id=provider_id, preview=preview
92-
)
84+
api_response = client.admin.Group.ProviderInfo.replace(group_id, provider_id=provider_id)
9385
print("The replace response:\n")
9486
pprint(api_response)
9587
except foundry_sdk.PalantirRPCException as e:

‎docs/v2/Admin/Host.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Method | HTTP request | Release Stage |
44
------------- | ------------- | ----- |
5-
[**list**](#list) | **GET** /v2/admin/enrollments/{enrollmentRid}/hosts | Private Beta |
5+
[**list**](#list) | **GET** /v2/admin/enrollments/{enrollmentRid}/hosts | Public Beta |
66

77
# **list**
88
Lists all Hosts.

0 commit comments

Comments
 (0)