Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ No description provided (generated by Openapi Generator https://github.com/opena
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 0.1.0
- Package version: 4.22.1
- Package version: 4.23.0
- Generator version: 7.9.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

Expand Down Expand Up @@ -136,6 +136,7 @@ Class | Method | HTTP request | Description
*EXTERNALApi* | [**get_usage_daily_bills_get**](docs/EXTERNALApi.md#get_usage_daily_bills_get) | **GET** /daily_bills | Get Usage
*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
*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
*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
*EXTERNALApi* | [**invite_user_organizations_invite_post**](docs/EXTERNALApi.md#invite_user_organizations_invite_post) | **POST** /organizations/invite | Invite User
*EXTERNALApi* | [**list_cluster_capacity_capacity_get**](docs/EXTERNALApi.md#list_cluster_capacity_capacity_get) | **GET** /capacity | List Cluster Capacity
*EXTERNALApi* | [**list_service_accounts_service_accounts_get**](docs/EXTERNALApi.md#list_service_accounts_service_accounts_get) | **GET** /service-accounts | List Service Accounts
Expand Down Expand Up @@ -270,7 +271,9 @@ Class | Method | HTTP request | Description
- [ValidationErrorLocInner](docs/ValidationErrorLocInner.md)
- [VaultScope](docs/VaultScope.md)
- [VolumeAccessMode](docs/VolumeAccessMode.md)
- [VolumeBackend](docs/VolumeBackend.md)
- [VolumeStatus](docs/VolumeStatus.md)
- [VolumeStatusResponse](docs/VolumeStatusResponse.md)


<a id="documentation-for-authorization"></a>
Expand Down
1 change: 1 addition & 0 deletions docs/CreateBlockVolumeRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Name | Type | Description | Notes
**cluster_id** | **int** | |
**backend** | **str** | |
**size_gb** | **int** | | [optional] [default to 100]
**storage_class** | **str** | | [optional]

## Example

Expand Down
1 change: 1 addition & 0 deletions docs/CreateVolumeRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Name | Type | Description | Notes
**cluster_id** | **int** | |
**backend** | **str** | |
**size_gb** | **int** | | [optional] [default to 100]
**storage_class** | **str** | | [optional]
**provider** | [**ObjectStorageProvider**](ObjectStorageProvider.md) | | [optional]
**bucket** | **str** | |
**region** | **str** | |
Expand Down
84 changes: 82 additions & 2 deletions docs/EXTERNALApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ Method | HTTP request | Description
[**get_usage_daily_bills_get**](EXTERNALApi.md#get_usage_daily_bills_get) | **GET** /daily_bills | Get Usage
[**get_usage_deployments_usage_deployment_id_get**](EXTERNALApi.md#get_usage_deployments_usage_deployment_id_get) | **GET** /deployments/usage/{deployment_id} | Get Usage
[**get_volume_endpoint_volumes_volume_id_get**](EXTERNALApi.md#get_volume_endpoint_volumes_volume_id_get) | **GET** /volumes/{volume_id} | Get Volume Endpoint
[**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
[**invite_user_organizations_invite_post**](EXTERNALApi.md#invite_user_organizations_invite_post) | **POST** /organizations/invite | Invite User
[**list_cluster_capacity_capacity_get**](EXTERNALApi.md#list_cluster_capacity_capacity_get) | **GET** /capacity | List Cluster Capacity
[**list_service_accounts_service_accounts_get**](EXTERNALApi.md#list_service_accounts_service_accounts_get) | **GET** /service-accounts | List Service Accounts
Expand Down Expand Up @@ -895,7 +896,7 @@ Name | Type | Description | Notes

Create Volume Endpoint

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

### Example

Expand Down Expand Up @@ -1278,7 +1279,7 @@ Name | Type | Description | Notes

Delete Volume Endpoint

Delete a volume. Only the owner or an admin with admin:manage_volumes may delete.
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.

### Example

Expand Down Expand Up @@ -3319,6 +3320,85 @@ 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)

# **get_volume_status_endpoint_volumes_status_volume_id_get**
> VolumeStatusResponse get_volume_status_endpoint_volumes_status_volume_id_get(volume_id)

Get Volume Status Endpoint

Live volume status: status is the stored intent, service_status is computed from the volume app's health and PVC phase.

### Example

* Bearer Authentication (HTTPBearer):

```python
import platform_api_python_client
from platform_api_python_client.models.volume_status_response import VolumeStatusResponse
from platform_api_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = platform_api_python_client.Configuration(
host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: HTTPBearer
configuration = platform_api_python_client.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with platform_api_python_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = platform_api_python_client.EXTERNALApi(api_client)
volume_id = 56 # int |

try:
# Get Volume Status Endpoint
api_response = api_instance.get_volume_status_endpoint_volumes_status_volume_id_get(volume_id)
print("The response of EXTERNALApi->get_volume_status_endpoint_volumes_status_volume_id_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling EXTERNALApi->get_volume_status_endpoint_volumes_status_volume_id_get: %s\n" % e)
```



### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**volume_id** | **int**| |

### Return type

[**VolumeStatusResponse**](VolumeStatusResponse.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response | - |
**422** | Validation Error | - |

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

# **invite_user_organizations_invite_post**
> object invite_user_organizations_invite_post(invite_user_request)

Expand Down
2 changes: 1 addition & 1 deletion docs/GetBlockVolumeResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Name | Type | Description | Notes
**pvc_name** | **str** | |
**created_at** | **datetime** | |
**size_gb** | **int** | |
**storage_class** | **str** | |

## Example

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


2 changes: 1 addition & 1 deletion docs/GetVolumeResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Name | Type | Description | Notes
**pvc_name** | **str** | |
**created_at** | **datetime** | |
**size_gb** | **int** | |
**storage_class** | **str** | |
**provider** | [**ObjectStorageProvider**](ObjectStorageProvider.md) | |
**bucket** | **str** | |
**region** | **str** | |
Expand Down Expand Up @@ -41,4 +42,3 @@ get_volume_response_from_dict = GetVolumeResponse.from_dict(get_volume_response_
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


2 changes: 1 addition & 1 deletion docs/PodDetails.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | | [optional]
**revision_number** | **int** | | [optional]
**component_type** | **str** | | [optional]
**status** | [**PodStatus**](PodStatus.md) | |
**error_message** | **str** | | [optional]

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


12 changes: 12 additions & 0 deletions docs/VolumeBackend.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# VolumeBackend


## Enum

* `BLOCK` (value: `'block'`)

* `OBJECT` (value: `'object'`)

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


33 changes: 33 additions & 0 deletions docs/VolumeStatusResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# VolumeStatusResponse


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | |
**backend** | [**VolumeBackend**](VolumeBackend.md) | |
**status** | [**VolumeStatus**](VolumeStatus.md) | |
**service_status** | [**ServiceStatus**](ServiceStatus.md) | | [optional]
**error_message** | **str** | | [optional]

## Example

```python
from platform_api_python_client.models.volume_status_response import VolumeStatusResponse

# TODO update the JSON string below
json = "{}"
# create an instance of VolumeStatusResponse from a JSON string
volume_status_response_instance = VolumeStatusResponse.from_json(json)
# print the JSON string representation of the object
print(VolumeStatusResponse.to_json())

# convert the object into a dict
volume_status_response_dict = volume_status_response_instance.to_dict()
# create an instance of VolumeStatusResponse from a dict
volume_status_response_from_dict = VolumeStatusResponse.from_dict(volume_status_response_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


4 changes: 3 additions & 1 deletion platform_api_python_client/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
""" # noqa: E501


__version__ = "4.22.1"
__version__ = "4.23.0"

# import apis into sdk package
from platform_api_python_client.api.external_api import EXTERNALApi
Expand Down Expand Up @@ -145,4 +145,6 @@
from platform_api_python_client.models.validation_error_loc_inner import ValidationErrorLocInner
from platform_api_python_client.models.vault_scope import VaultScope
from platform_api_python_client.models.volume_access_mode import VolumeAccessMode
from platform_api_python_client.models.volume_backend import VolumeBackend
from platform_api_python_client.models.volume_status import VolumeStatus
from platform_api_python_client.models.volume_status_response import VolumeStatusResponse
Loading
Loading