Skip to content

Commit 79303ad

Browse files
svc-centml-platformcentml-machine-user
svc-centml-platform
and
centml-machine-user
authored
Update clients to latest platform release (4.23.0) (#101)
Co-authored-by: platform CI <automation@centml.ai>
1 parent 8b88a1d commit 79303ad

31 files changed

Lines changed: 701 additions & 24 deletions

‎README.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ No description provided (generated by Openapi Generator https://github.com/opena
44
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
55

66
- API version: 0.1.0
7-
- Package version: 4.22.1
7+
- Package version: 4.23.0
88
- Generator version: 7.9.0
99
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
1010

@@ -136,6 +136,7 @@ Class | Method | HTTP request | Description
136136
*EXTERNALApi* | [**get_usage_daily_bills_get**](docs/EXTERNALApi.md#get_usage_daily_bills_get) | **GET** /daily_bills | Get Usage
137137
*EXTERNALApi* | [**get_usage_deployments_usage_deployment_id_get**](docs/EXTERNALApi.md#get_usage_deployments_usage_deployment_id_get) | **GET** /deployments/usage/{deployment_id} | Get Usage
138138
*EXTERNALApi* | [**get_volume_endpoint_volumes_volume_id_get**](docs/EXTERNALApi.md#get_volume_endpoint_volumes_volume_id_get) | **GET** /volumes/{volume_id} | Get Volume Endpoint
139+
*EXTERNALApi* | [**get_volume_status_endpoint_volumes_status_volume_id_get**](docs/EXTERNALApi.md#get_volume_status_endpoint_volumes_status_volume_id_get) | **GET** /volumes/status/{volume_id} | Get Volume Status Endpoint
139140
*EXTERNALApi* | [**invite_user_organizations_invite_post**](docs/EXTERNALApi.md#invite_user_organizations_invite_post) | **POST** /organizations/invite | Invite User
140141
*EXTERNALApi* | [**list_cluster_capacity_capacity_get**](docs/EXTERNALApi.md#list_cluster_capacity_capacity_get) | **GET** /capacity | List Cluster Capacity
141142
*EXTERNALApi* | [**list_service_accounts_service_accounts_get**](docs/EXTERNALApi.md#list_service_accounts_service_accounts_get) | **GET** /service-accounts | List Service Accounts
@@ -270,7 +271,9 @@ Class | Method | HTTP request | Description
270271
- [ValidationErrorLocInner](docs/ValidationErrorLocInner.md)
271272
- [VaultScope](docs/VaultScope.md)
272273
- [VolumeAccessMode](docs/VolumeAccessMode.md)
274+
- [VolumeBackend](docs/VolumeBackend.md)
273275
- [VolumeStatus](docs/VolumeStatus.md)
276+
- [VolumeStatusResponse](docs/VolumeStatusResponse.md)
274277

275278

276279
<a id="documentation-for-authorization"></a>

‎docs/CreateBlockVolumeRequest.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
99
**cluster_id** | **int** | |
1010
**backend** | **str** | |
1111
**size_gb** | **int** | | [optional] [default to 100]
12+
**storage_class** | **str** | | [optional]
1213

1314
## Example
1415

‎docs/CreateVolumeRequest.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
99
**cluster_id** | **int** | |
1010
**backend** | **str** | |
1111
**size_gb** | **int** | | [optional] [default to 100]
12+
**storage_class** | **str** | | [optional]
1213
**provider** | [**ObjectStorageProvider**](ObjectStorageProvider.md) | | [optional]
1314
**bucket** | **str** | |
1415
**region** | **str** | |

‎docs/EXTERNALApi.md‎

Lines changed: 82 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ Method | HTTP request | Description
4646
[**get_usage_daily_bills_get**](EXTERNALApi.md#get_usage_daily_bills_get) | **GET** /daily_bills | Get Usage
4747
[**get_usage_deployments_usage_deployment_id_get**](EXTERNALApi.md#get_usage_deployments_usage_deployment_id_get) | **GET** /deployments/usage/{deployment_id} | Get Usage
4848
[**get_volume_endpoint_volumes_volume_id_get**](EXTERNALApi.md#get_volume_endpoint_volumes_volume_id_get) | **GET** /volumes/{volume_id} | Get Volume Endpoint
49+
[**get_volume_status_endpoint_volumes_status_volume_id_get**](EXTERNALApi.md#get_volume_status_endpoint_volumes_status_volume_id_get) | **GET** /volumes/status/{volume_id} | Get Volume Status Endpoint
4950
[**invite_user_organizations_invite_post**](EXTERNALApi.md#invite_user_organizations_invite_post) | **POST** /organizations/invite | Invite User
5051
[**list_cluster_capacity_capacity_get**](EXTERNALApi.md#list_cluster_capacity_capacity_get) | **GET** /capacity | List Cluster Capacity
5152
[**list_service_accounts_service_accounts_get**](EXTERNALApi.md#list_service_accounts_service_accounts_get) | **GET** /service-accounts | List Service Accounts
@@ -895,7 +896,7 @@ Name | Type | Description | Notes
895896
896897
Create Volume Endpoint
897898

898-
Create a volume. The backend field selects block (RWO) or object (RWX) storage.
899+
Create a volume. Only the block backend is provisioned; object lands in CCL-147.
899900

900901
### Example
901902

@@ -1278,7 +1279,7 @@ Name | Type | Description | Notes
12781279
12791280
Delete Volume Endpoint
12801281

1281-
Delete a volume. Only the owner or an admin with admin:manage_volumes may delete.
1282+
Delete a volume: tear down its ArgoCD app (and PVC) if reachable, then soft-delete the row. Only the owner or an admin with admin:manage_volumes may delete.
12821283

12831284
### Example
12841285

@@ -3319,6 +3320,85 @@ Name | Type | Description | Notes
33193320

33203321
[[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)
33213322

3323+
# **get_volume_status_endpoint_volumes_status_volume_id_get**
3324+
> VolumeStatusResponse get_volume_status_endpoint_volumes_status_volume_id_get(volume_id)
3325+
3326+
Get Volume Status Endpoint
3327+
3328+
Live volume status: status is the stored intent, service_status is computed from the volume app's health and PVC phase.
3329+
3330+
### Example
3331+
3332+
* Bearer Authentication (HTTPBearer):
3333+
3334+
```python
3335+
import platform_api_python_client
3336+
from platform_api_python_client.models.volume_status_response import VolumeStatusResponse
3337+
from platform_api_python_client.rest import ApiException
3338+
from pprint import pprint
3339+
3340+
# Defining the host is optional and defaults to http://localhost
3341+
# See configuration.py for a list of all supported configuration parameters.
3342+
configuration = platform_api_python_client.Configuration(
3343+
host = "http://localhost"
3344+
)
3345+
3346+
# The client must configure the authentication and authorization parameters
3347+
# in accordance with the API server security policy.
3348+
# Examples for each auth method are provided below, use the example that
3349+
# satisfies your auth use case.
3350+
3351+
# Configure Bearer authorization: HTTPBearer
3352+
configuration = platform_api_python_client.Configuration(
3353+
access_token = os.environ["BEARER_TOKEN"]
3354+
)
3355+
3356+
# Enter a context with an instance of the API client
3357+
with platform_api_python_client.ApiClient(configuration) as api_client:
3358+
# Create an instance of the API class
3359+
api_instance = platform_api_python_client.EXTERNALApi(api_client)
3360+
volume_id = 56 # int |
3361+
3362+
try:
3363+
# Get Volume Status Endpoint
3364+
api_response = api_instance.get_volume_status_endpoint_volumes_status_volume_id_get(volume_id)
3365+
print("The response of EXTERNALApi->get_volume_status_endpoint_volumes_status_volume_id_get:\n")
3366+
pprint(api_response)
3367+
except Exception as e:
3368+
print("Exception when calling EXTERNALApi->get_volume_status_endpoint_volumes_status_volume_id_get: %s\n" % e)
3369+
```
3370+
3371+
3372+
3373+
### Parameters
3374+
3375+
3376+
Name | Type | Description | Notes
3377+
------------- | ------------- | ------------- | -------------
3378+
**volume_id** | **int**| |
3379+
3380+
### Return type
3381+
3382+
[**VolumeStatusResponse**](VolumeStatusResponse.md)
3383+
3384+
### Authorization
3385+
3386+
[HTTPBearer](../README.md#HTTPBearer)
3387+
3388+
### HTTP request headers
3389+
3390+
- **Content-Type**: Not defined
3391+
- **Accept**: application/json
3392+
3393+
### HTTP response details
3394+
3395+
| Status code | Description | Response headers |
3396+
|-------------|-------------|------------------|
3397+
**200** | Successful Response | - |
3398+
**422** | Validation Error | - |
3399+
3400+
[[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)
3401+
33223402
# **invite_user_organizations_invite_post**
33233403
> object invite_user_organizations_invite_post(invite_user_request)
33243404

‎docs/GetBlockVolumeResponse.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
1414
**pvc_name** | **str** | |
1515
**created_at** | **datetime** | |
1616
**size_gb** | **int** | |
17+
**storage_class** | **str** | |
1718

1819
## Example
1920

@@ -34,4 +35,3 @@ get_block_volume_response_from_dict = GetBlockVolumeResponse.from_dict(get_block
3435
```
3536
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
3637

37-

‎docs/GetVolumeResponse.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
1414
**pvc_name** | **str** | |
1515
**created_at** | **datetime** | |
1616
**size_gb** | **int** | |
17+
**storage_class** | **str** | |
1718
**provider** | [**ObjectStorageProvider**](ObjectStorageProvider.md) | |
1819
**bucket** | **str** | |
1920
**region** | **str** | |
@@ -41,4 +42,3 @@ get_volume_response_from_dict = GetVolumeResponse.from_dict(get_volume_response_
4142
```
4243
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
4344

44-

‎docs/PodDetails.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
88
**name** | **str** | | [optional]
99
**revision_number** | **int** | | [optional]
10+
**component_type** | **str** | | [optional]
1011
**status** | [**PodStatus**](PodStatus.md) | |
1112
**error_message** | **str** | | [optional]
1213

@@ -29,4 +30,3 @@ pod_details_from_dict = PodDetails.from_dict(pod_details_dict)
2930
```
3031
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
3132

32-

‎docs/VolumeBackend.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# VolumeBackend
2+
3+
4+
## Enum
5+
6+
* `BLOCK` (value: `'block'`)
7+
8+
* `OBJECT` (value: `'object'`)
9+
10+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11+
12+

‎docs/VolumeStatusResponse.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# VolumeStatusResponse
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**id** | **int** | |
9+
**backend** | [**VolumeBackend**](VolumeBackend.md) | |
10+
**status** | [**VolumeStatus**](VolumeStatus.md) | |
11+
**service_status** | [**ServiceStatus**](ServiceStatus.md) | | [optional]
12+
**error_message** | **str** | | [optional]
13+
14+
## Example
15+
16+
```python
17+
from platform_api_python_client.models.volume_status_response import VolumeStatusResponse
18+
19+
# TODO update the JSON string below
20+
json = "{}"
21+
# create an instance of VolumeStatusResponse from a JSON string
22+
volume_status_response_instance = VolumeStatusResponse.from_json(json)
23+
# print the JSON string representation of the object
24+
print(VolumeStatusResponse.to_json())
25+
26+
# convert the object into a dict
27+
volume_status_response_dict = volume_status_response_instance.to_dict()
28+
# create an instance of VolumeStatusResponse from a dict
29+
volume_status_response_from_dict = VolumeStatusResponse.from_dict(volume_status_response_dict)
30+
```
31+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
32+
33+

‎platform_api_python_client/__init__.py‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
""" # noqa: E501
1515

1616

17-
__version__ = "4.22.1"
17+
__version__ = "4.23.0"
1818

1919
# import apis into sdk package
2020
from platform_api_python_client.api.external_api import EXTERNALApi
@@ -145,4 +145,6 @@
145145
from platform_api_python_client.models.validation_error_loc_inner import ValidationErrorLocInner
146146
from platform_api_python_client.models.vault_scope import VaultScope
147147
from platform_api_python_client.models.volume_access_mode import VolumeAccessMode
148+
from platform_api_python_client.models.volume_backend import VolumeBackend
148149
from platform_api_python_client.models.volume_status import VolumeStatus
150+
from platform_api_python_client.models.volume_status_response import VolumeStatusResponse

0 commit comments

Comments
 (0)