Skip to content

Commit 7b985e2

Browse files
eric-maynarderic-maynard
authored
Regenerate bundled spec & Regenerate Python client (#1751)
I ran these commands from main: ``` redocly bundle spec/polaris-catalog-service.yaml -o spec/generated/bundled-polaris-catalog-service.yaml ./gradlew regeneratePythonClient ``` I didn't realize before that some Python types are generated form the bundled spec, so some of the fixes from #1347 didn't get properly applied before.
1 parent f1a521e commit 7b985e2

Some content is hidden

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

44 files changed

+1743
-170
lines changed

‎client/python/docs/AuthenticationParameters.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
-->
2121
# AuthenticationParameters
2222

23-
Authentication-specific information for a REST connection
23+
Authentication-specific information for a connection
2424

2525
## Properties
2626

‎client/python/docs/AwsIamServiceIdentityInfo.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
<!--
2+
3+
Licensed to the Apache Software Foundation (ASF) under one
4+
or more contributor license agreements. See the NOTICE file
5+
distributed with this work for additional information
6+
regarding copyright ownership. The ASF licenses this file
7+
to you under the Apache License, Version 2.0 (the
8+
"License"); you may not use this file except in compliance
9+
with the License. You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing,
14+
software distributed under the License is distributed on an
15+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16+
KIND, either express or implied. See the License for the
17+
specific language governing permissions and limitations
18+
under the License.
19+
20+
-->
21+
# AwsIamServiceIdentityInfo
22+
23+
24+
## Properties
25+
26+
Name | Type | Description | Notes
27+
------------ | ------------- | ------------- | -------------
28+
**iam_arn** | **str** | The ARN of the IAM user or IAM role Polaris uses to assume roles and then access external resources. |
29+
30+
## Example
31+
32+
```python
33+
from polaris.management.models.aws_iam_service_identity_info import AwsIamServiceIdentityInfo
34+
35+
# TODO update the JSON string below
36+
json = "{}"
37+
# create an instance of AwsIamServiceIdentityInfo from a JSON string
38+
aws_iam_service_identity_info_instance = AwsIamServiceIdentityInfo.from_json(json)
39+
# print the JSON string representation of the object
40+
print(AwsIamServiceIdentityInfo.to_json())
41+
42+
# convert the object into a dict
43+
aws_iam_service_identity_info_dict = aws_iam_service_identity_info_instance.to_dict()
44+
# create an instance of AwsIamServiceIdentityInfo from a dict
45+
aws_iam_service_identity_info_from_dict = AwsIamServiceIdentityInfo.from_dict(aws_iam_service_identity_info_dict)
46+
```
47+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
48+
49+

‎client/python/docs/CatalogPrivilege.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,22 @@
7373

7474
* `VIEW_FULL_METADATA` (value: `'VIEW_FULL_METADATA'`)
7575

76+
* `POLICY_CREATE` (value: `'POLICY_CREATE'`)
77+
78+
* `POLICY_WRITE` (value: `'POLICY_WRITE'`)
79+
80+
* `POLICY_READ` (value: `'POLICY_READ'`)
81+
82+
* `POLICY_DROP` (value: `'POLICY_DROP'`)
83+
84+
* `POLICY_LIST` (value: `'POLICY_LIST'`)
85+
86+
* `POLICY_FULL_METADATA` (value: `'POLICY_FULL_METADATA'`)
87+
88+
* `CATALOG_ATTACH_POLICY` (value: `'CATALOG_ATTACH_POLICY'`)
89+
90+
* `CATALOG_DETACH_POLICY` (value: `'CATALOG_DETACH_POLICY'`)
91+
7692
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
7793

7894

‎client/python/docs/ConnectionConfigInfo.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ Name | Type | Description | Notes
2929
**connection_type** | **str** | The type of remote catalog service represented by this connection |
3030
**uri** | **str** | URI to the remote catalog service | [optional]
3131
**authentication_parameters** | [**AuthenticationParameters**](AuthenticationParameters.md) | | [optional]
32+
**service_identity** | [**ServiceIdentityInfo**](ServiceIdentityInfo.md) | | [optional]
3233

3334
## Example
3435

‎client/python/docs/HadoopConnectionConfigInfo.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
<!--
2+
3+
Licensed to the Apache Software Foundation (ASF) under one
4+
or more contributor license agreements. See the NOTICE file
5+
distributed with this work for additional information
6+
regarding copyright ownership. The ASF licenses this file
7+
to you under the Apache License, Version 2.0 (the
8+
"License"); you may not use this file except in compliance
9+
with the License. You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing,
14+
software distributed under the License is distributed on an
15+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16+
KIND, either express or implied. See the License for the
17+
specific language governing permissions and limitations
18+
under the License.
19+
20+
-->
21+
# HadoopConnectionConfigInfo
22+
23+
Configuration necessary for connecting to a Hadoop Catalog
24+
25+
## Properties
26+
27+
Name | Type | Description | Notes
28+
------------ | ------------- | ------------- | -------------
29+
**warehouse** | **str** | The file path to where this catalog should store tables | [optional]
30+
31+
## Example
32+
33+
```python
34+
from polaris.management.models.hadoop_connection_config_info import HadoopConnectionConfigInfo
35+
36+
# TODO update the JSON string below
37+
json = "{}"
38+
# create an instance of HadoopConnectionConfigInfo from a JSON string
39+
hadoop_connection_config_info_instance = HadoopConnectionConfigInfo.from_json(json)
40+
# print the JSON string representation of the object
41+
print(HadoopConnectionConfigInfo.to_json())
42+
43+
# convert the object into a dict
44+
hadoop_connection_config_info_dict = hadoop_connection_config_info_instance.to_dict()
45+
# create an instance of HadoopConnectionConfigInfo from a dict
46+
hadoop_connection_config_info_from_dict = HadoopConnectionConfigInfo.from_dict(hadoop_connection_config_info_dict)
47+
```
48+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
49+
50+

‎client/python/docs/IcebergCatalogAPI.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1432,7 +1432,7 @@ Name | Type | Description | Notes
14321432
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
14331433

14341434
# **load_table**
1435-
> LoadTableResult load_table(x_iceberg_access_delegation=x_iceberg_access_delegation, if_none_match=if_none_match, snapshots=snapshots)
1435+
> LoadTableResult load_table(prefix, namespace, table, x_iceberg_access_delegation=x_iceberg_access_delegation, if_none_match=if_none_match, snapshots=snapshots)
14361436
14371437
Load a table from the catalog
14381438

@@ -1471,13 +1471,16 @@ configuration = polaris.catalog.Configuration(
14711471
with polaris.catalog.ApiClient(configuration) as api_client:
14721472
# Create an instance of the API class
14731473
api_instance = polaris.catalog.IcebergCatalogAPI(api_client)
1474+
prefix = 'prefix_example' # str | An optional prefix in the path
1475+
namespace = 'accounting' # str | A namespace identifier as a single string. Multipart namespace parts should be separated by the unit separator (`0x1F`) byte.
1476+
table = 'sales' # str | A table name
14741477
x_iceberg_access_delegation = 'vended-credentials,remote-signing' # str | Optional signal to the server that the client supports delegated access via a comma-separated list of access mechanisms. The server may choose to supply access via any or none of the requested mechanisms. Specific properties and handling for `vended-credentials` is documented in the `LoadTableResult` schema section of this spec document. The protocol and specification for `remote-signing` is documented in the `s3-signer-open-api.yaml` OpenApi spec in the `aws` module. (optional)
14751478
if_none_match = 'if_none_match_example' # str | An optional header that allows the server to return 304 (Not Modified) if the metadata is current. The content is the value of the ETag received in a CreateTableResponse or LoadTableResponse. (optional)
14761479
snapshots = 'snapshots_example' # str | The snapshots to return in the body of the metadata. Setting the value to `all` would return the full set of snapshots currently valid for the table. Setting the value to `refs` would load all snapshots referenced by branches or tags. Default if no param is provided is `all`. (optional)
14771480

14781481
try:
14791482
# Load a table from the catalog
1480-
api_response = api_instance.load_table(x_iceberg_access_delegation=x_iceberg_access_delegation, if_none_match=if_none_match, snapshots=snapshots)
1483+
api_response = api_instance.load_table(prefix, namespace, table, x_iceberg_access_delegation=x_iceberg_access_delegation, if_none_match=if_none_match, snapshots=snapshots)
14811484
print("The response of IcebergCatalogAPI->load_table:\n")
14821485
pprint(api_response)
14831486
except Exception as e:
@@ -1491,6 +1494,9 @@ with polaris.catalog.ApiClient(configuration) as api_client:
14911494

14921495
Name | Type | Description | Notes
14931496
------------- | ------------- | ------------- | -------------
1497+
**prefix** | **str**| An optional prefix in the path |
1498+
**namespace** | **str**| A namespace identifier as a single string. Multipart namespace parts should be separated by the unit separator (&#x60;0x1F&#x60;) byte. |
1499+
**table** | **str**| A table name |
14941500
**x_iceberg_access_delegation** | **str**| Optional signal to the server that the client supports delegated access via a comma-separated list of access mechanisms. The server may choose to supply access via any or none of the requested mechanisms. Specific properties and handling for &#x60;vended-credentials&#x60; is documented in the &#x60;LoadTableResult&#x60; schema section of this spec document. The protocol and specification for &#x60;remote-signing&#x60; is documented in the &#x60;s3-signer-open-api.yaml&#x60; OpenApi spec in the &#x60;aws&#x60; module. | [optional]
14951501
**if_none_match** | **str**| An optional header that allows the server to return 304 (Not Modified) if the metadata is current. The content is the value of the ETag received in a CreateTableResponse or LoadTableResponse. | [optional]
14961502
**snapshots** | **str**| The snapshots to return in the body of the metadata. Setting the value to &#x60;all&#x60; would return the full set of snapshots currently valid for the table. Setting the value to &#x60;refs&#x60; would load all snapshots referenced by branches or tags. Default if no param is provided is &#x60;all&#x60;. | [optional]

‎client/python/docs/NamespacePrivilege.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,22 @@
6969

7070
* `VIEW_FULL_METADATA` (value: `'VIEW_FULL_METADATA'`)
7171

72+
* `POLICY_CREATE` (value: `'POLICY_CREATE'`)
73+
74+
* `POLICY_WRITE` (value: `'POLICY_WRITE'`)
75+
76+
* `POLICY_READ` (value: `'POLICY_READ'`)
77+
78+
* `POLICY_DROP` (value: `'POLICY_DROP'`)
79+
80+
* `POLICY_LIST` (value: `'POLICY_LIST'`)
81+
82+
* `POLICY_FULL_METADATA` (value: `'POLICY_FULL_METADATA'`)
83+
84+
* `NAMESPACE_ATTACH_POLICY` (value: `'NAMESPACE_ATTACH_POLICY'`)
85+
86+
* `NAMESPACE_DETACH_POLICY` (value: `'NAMESPACE_DETACH_POLICY'`)
87+
7288
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
7389

7490

‎client/python/docs/PolicyGrant.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
<!--
2+
3+
Licensed to the Apache Software Foundation (ASF) under one
4+
or more contributor license agreements. See the NOTICE file
5+
distributed with this work for additional information
6+
regarding copyright ownership. The ASF licenses this file
7+
to you under the Apache License, Version 2.0 (the
8+
"License"); you may not use this file except in compliance
9+
with the License. You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing,
14+
software distributed under the License is distributed on an
15+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16+
KIND, either express or implied. See the License for the
17+
specific language governing permissions and limitations
18+
under the License.
19+
20+
-->
21+
# PolicyGrant
22+
23+
24+
## Properties
25+
26+
Name | Type | Description | Notes
27+
------------ | ------------- | ------------- | -------------
28+
**namespace** | **List[str]** | |
29+
**policy_name** | **str** | |
30+
**privilege** | [**PolicyPrivilege**](PolicyPrivilege.md) | |
31+
32+
## Example
33+
34+
```python
35+
from polaris.management.models.policy_grant import PolicyGrant
36+
37+
# TODO update the JSON string below
38+
json = "{}"
39+
# create an instance of PolicyGrant from a JSON string
40+
policy_grant_instance = PolicyGrant.from_json(json)
41+
# print the JSON string representation of the object
42+
print(PolicyGrant.to_json())
43+
44+
# convert the object into a dict
45+
policy_grant_dict = policy_grant_instance.to_dict()
46+
# create an instance of PolicyGrant from a dict
47+
policy_grant_from_dict = PolicyGrant.from_dict(policy_grant_dict)
48+
```
49+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
50+
51+

‎client/python/docs/PolicyPrivilege.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
<!--
2+
3+
Licensed to the Apache Software Foundation (ASF) under one
4+
or more contributor license agreements. See the NOTICE file
5+
distributed with this work for additional information
6+
regarding copyright ownership. The ASF licenses this file
7+
to you under the Apache License, Version 2.0 (the
8+
"License"); you may not use this file except in compliance
9+
with the License. You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing,
14+
software distributed under the License is distributed on an
15+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16+
KIND, either express or implied. See the License for the
17+
specific language governing permissions and limitations
18+
under the License.
19+
20+
-->
21+
# PolicyPrivilege
22+
23+
24+
## Enum
25+
26+
* `CATALOG_MANAGE_ACCESS` (value: `'CATALOG_MANAGE_ACCESS'`)
27+
28+
* `POLICY_READ` (value: `'POLICY_READ'`)
29+
30+
* `POLICY_DROP` (value: `'POLICY_DROP'`)
31+
32+
* `POLICY_WRITE` (value: `'POLICY_WRITE'`)
33+
34+
* `POLICY_LIST` (value: `'POLICY_LIST'`)
35+
36+
* `POLICY_FULL_METADATA` (value: `'POLICY_FULL_METADATA'`)
37+
38+
* `POLICY_ATTACH` (value: `'POLICY_ATTACH'`)
39+
40+
* `POLICY_DETACH` (value: `'POLICY_DETACH'`)
41+
42+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
43+
44+

‎client/python/docs/PrincipalRole.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
Name | Type | Description | Notes
2727
------------ | ------------- | ------------- | -------------
2828
**name** | **str** | The name of the role |
29+
**federated** | **bool** | Whether the principal role is a federated role (that is, managed by an external identity provider) | [optional] [default to False]
2930
**properties** | **Dict[str, str]** | | [optional]
3031
**create_timestamp** | **int** | | [optional]
3132
**last_update_timestamp** | **int** | | [optional]

0 commit comments

Comments
 (0)