Skip to content

Added inheritance support for DTC objects for python-client #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
unasra merged 2 commits into from
May 20, 2026
Merged

Added inheritance support for DTC objects for python-client #32

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
169cc93
Added inheritance support for dtc on python-client
Tejashree-RS May 19, 2026
524da99
documentation update
Tejashree-RS May 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
128 changes: 128 additions & 0 deletions src/dtc/api/policy_api.py
View file
Open in desktop

Large diffs are not rendered by default.

128 changes: 128 additions & 0 deletions src/dtc/api/pool_api.py
View file
Open in desktop

Large diffs are not rendered by default.

12 changes: 8 additions & 4 deletions src/dtc/docs/PolicyApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Method | HTTP request | Description


# **create**
> CreatePolicyResponse create(body)
> CreatePolicyResponse create(body, inherit=inherit)

Create the Policy object.

Expand Down Expand Up @@ -65,6 +65,7 @@ with ApiClient(configuration) as api_client:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**Policy**](Policy.md)| |
**inherit** | **str**| This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | [optional]

### Return type

Expand Down Expand Up @@ -162,7 +163,7 @@ void (empty response body)
[[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)

# **list**
> ListPolicyResponse list(fields=fields, filter=filter, offset=offset, limit=limit, page_token=page_token, order_by=order_by, tfilter=tfilter, torder_by=torder_by)
> ListPolicyResponse list(fields=fields, filter=filter, offset=offset, limit=limit, page_token=page_token, order_by=order_by, tfilter=tfilter, torder_by=torder_by, inherit=inherit)

Retrieve Policy objects.

Expand Down Expand Up @@ -221,6 +222,7 @@ Name | Type | Description | Notes
**order_by** | **str**| A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | [optional]
**tfilter** | **str**| This parameter is used for filtering by tags. | [optional]
**torder_by** | **str**| This parameter is used for sorting by tags. | [optional]
**inherit** | **str**| This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | [optional]

### Return type

Expand All @@ -244,7 +246,7 @@ Name | Type | Description | Notes
[[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)

# **read**
> ReadPolicyResponse read(id, fields=fields)
> ReadPolicyResponse read(id, fields=fields, inherit=inherit)

Retrieve the Policy object.

Expand Down Expand Up @@ -298,6 +300,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **str**| An application specific resource identity of a resource |
**fields** | **str**| A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | [optional]
**inherit** | **str**| This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | [optional]

### Return type

Expand All @@ -321,7 +324,7 @@ Name | Type | Description | Notes
[[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)

# **update**
> UpdatePolicyResponse update(id, body)
> UpdatePolicyResponse update(id, body, inherit=inherit)

Update the Policy object.

Expand Down Expand Up @@ -376,6 +379,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **str**| An application specific resource identity of a resource |
**body** | [**Policy**](Policy.md)| |
**inherit** | **str**| This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | [optional]

### Return type

Expand Down
12 changes: 8 additions & 4 deletions src/dtc/docs/PoolApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Method | HTTP request | Description


# **create**
> CreatePoolResponse create(body)
> CreatePoolResponse create(body, inherit=inherit)

Create the Pool object.

Expand Down Expand Up @@ -65,6 +65,7 @@ with ApiClient(configuration) as api_client:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**Pool**](Pool.md)| |
**inherit** | **str**| This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | [optional]

### Return type

Expand Down Expand Up @@ -162,7 +163,7 @@ void (empty response body)
[[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)

# **list**
> ListPoolResponse list(fields=fields, filter=filter, offset=offset, limit=limit, page_token=page_token, order_by=order_by, tfilter=tfilter, torder_by=torder_by)
> ListPoolResponse list(fields=fields, filter=filter, offset=offset, limit=limit, page_token=page_token, order_by=order_by, tfilter=tfilter, torder_by=torder_by, inherit=inherit)

Retrieve Pool objects.

Expand Down Expand Up @@ -221,6 +222,7 @@ Name | Type | Description | Notes
**order_by** | **str**| A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | [optional]
**tfilter** | **str**| This parameter is used for filtering by tags. | [optional]
**torder_by** | **str**| This parameter is used for sorting by tags. | [optional]
**inherit** | **str**| This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | [optional]

### Return type

Expand All @@ -244,7 +246,7 @@ Name | Type | Description | Notes
[[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)

# **read**
> ReadPoolResponse read(id, fields=fields)
> ReadPoolResponse read(id, fields=fields, inherit=inherit)

Retrieve the Pool object.

Expand Down Expand Up @@ -298,6 +300,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **str**| An application specific resource identity of a resource |
**fields** | **str**| A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | [optional]
**inherit** | **str**| This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | [optional]

### Return type

Expand All @@ -321,7 +324,7 @@ Name | Type | Description | Notes
[[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)

# **update**
> UpdatePoolResponse update(id, body)
> UpdatePoolResponse update(id, body, inherit=inherit)

Update the Pool object.

Expand Down Expand Up @@ -376,6 +379,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **str**| An application specific resource identity of a resource |
**body** | [**Pool**](Pool.md)| |
**inherit** | **str**| This parameter is used for getting inheritance_sources. Allowed values: * _none_, * _partial_, * _full_. Defaults to _none | [optional]

### Return type

Expand Down
2 changes: 1 addition & 1 deletion src/dtc/docs/PoolServer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | Display name of __Server__. | [optional] [readonly]
**server_id** | **str** | The resource identifier. |
**weight** | **int** | Weight of __Server__ to be used for load balancing. Unsigned integer, min 1; max 65535. |
**weight** | **int** | Weight of __Server__ to be used for load balancing. Unsigned integer, min 1; max 65535. | [optional]

## Example

Expand Down
3 changes: 2 additions & 1 deletion src/dtc/models/pool_server.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@ class PoolServer(BaseModel):
name: Optional[StrictStr] = Field(
default=None, description="Display name of __Server__.")
server_id: StrictStr = Field(description="The resource identifier.")
weight: StrictInt = Field(
weight: Optional[StrictInt] = Field(
default=None,
description=
"Weight of __Server__ to be used for load balancing. Unsigned integer, min 1; max 65535."
)
Expand Down
Loading