cosmotech.asset-data-layer-client 0.2.0rc1__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- cosmotech_asset_data_layer_client-0.2.0rc1/LICENSE +17 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/PKG-INFO +207 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/README.md +188 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/__init__.py +0 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/__init__.py +187 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/api/__init__.py +40 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/api/csmapi_api.py +320 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/api/datasets_api.py +5687 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/api/default_api.py +277 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/api/runners_api.py +981 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/api/scenarios_api.py +3004 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/api_client.py +842 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/api_response.py +21 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/configuration.py +654 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/exceptions.py +218 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/models/__init__.py +136 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/models/dataset_access_create_request.py +92 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/models/dataset_access_response.py +90 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/models/dataset_access_update_request.py +89 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/models/dataset_detail_response.py +184 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/models/dataset_file_response.py +88 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/models/dataset_list_item_response.py +166 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/models/dataset_role.py +38 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/models/dataset_scenario_response.py +99 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/models/dataset_security_response.py +97 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/models/dataset_status.py +39 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/models/dataset_transformation_status_response.py +137 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/models/dataset_validation_diagnostic_response.py +106 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/models/dataset_validation_status_response.py +138 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/models/http_validation_error.py +95 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/models/location_inner.py +138 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/models/metadata.py +115 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/models/resource_size_info.py +90 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/models/run_timing.py +117 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/models/run_timing_node.py +123 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/models/run_timing_step.py +107 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/models/runner_list_item_response.py +241 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/models/runner_resource_sizing.py +97 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/models/runner_response.py +241 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/models/runner_run_template_parameter_value.py +104 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/models/runner_update_request.py +176 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/models/runner_validation_status.py +39 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/models/scenario_create_request.py +117 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/models/scenario_diagnostic_response.py +99 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/models/scenario_edition_response.py +97 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/models/scenario_response.py +141 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/models/scenario_state.py +39 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/models/scenario_transformation_response.py +130 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/models/validation_error.py +108 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/py.typed +0 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech/asset_data_layer_client/rest.py +334 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech.asset_data_layer_client.egg-info/PKG-INFO +207 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech.asset_data_layer_client.egg-info/SOURCES.txt +96 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech.asset_data_layer_client.egg-info/dependency_links.txt +1 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech.asset_data_layer_client.egg-info/requires.txt +4 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/cosmotech.asset_data_layer_client.egg-info/top_level.txt +1 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/pyproject.toml +93 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/setup.cfg +7 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/setup.py +47 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/test/test_csmapi_api.py +38 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/test/test_dataset_access_create_request.py +54 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/test/test_dataset_access_response.py +54 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/test/test_dataset_access_update_request.py +52 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/test/test_dataset_detail_response.py +93 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/test/test_dataset_file_response.py +52 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/test/test_dataset_list_item_response.py +82 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/test/test_dataset_role.py +33 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/test/test_dataset_scenario_response.py +57 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/test/test_dataset_security_response.py +57 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/test/test_dataset_status.py +33 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/test/test_dataset_transformation_status_response.py +90 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/test/test_dataset_validation_diagnostic_response.py +57 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/test/test_dataset_validation_status_response.py +93 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/test/test_datasets_api.py +157 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/test/test_default_api.py +38 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/test/test_http_validation_error.py +60 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/test/test_location_inner.py +50 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/test/test_metadata.py +56 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/test/test_resource_size_info.py +54 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/test/test_run_timing.py +78 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/test/test_run_timing_node.py +62 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/test/test_run_timing_step.py +57 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/test/test_runner_list_item_response.py +83 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/test/test_runner_resource_sizing.py +62 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/test/test_runner_response.py +83 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/test/test_runner_run_template_parameter_value.py +56 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/test/test_runner_update_request.py +77 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/test/test_runner_validation_status.py +33 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/test/test_runners_api.py +52 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/test/test_scenario_create_request.py +56 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/test/test_scenario_diagnostic_response.py +56 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/test/test_scenario_edition_response.py +60 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/test/test_scenario_response.py +102 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/test/test_scenario_state.py +33 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/test/test_scenario_transformation_response.py +88 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/test/test_scenarios_api.py +94 -0
- cosmotech_asset_data_layer_client-0.2.0rc1/test/test_validation_error.py +62 -0
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
LICENSE
|
|
2
|
+
=======
|
|
3
|
+
|
|
4
|
+
Copyright 2021-2026 Cosmo Tech
|
|
5
|
+
|
|
6
|
+
You are authorized to use this software following the execution of a specific agreement with Cosmo Tech or with an authorized licensee of Cosmo Tech.
|
|
7
|
+
|
|
8
|
+
Accordingly you should refer to this specific agreement for the purpose of the extent of the use that is permitted. This use shall mainly consist in using, displaying and executing the software for your own needs.
|
|
9
|
+
|
|
10
|
+
Except otherwise provided in the above-mentioned specific agreement:
|
|
11
|
+
- you are not allowed to use this software for commercial purpose or to redistribute it without prior authorization from Cosmo Tech;
|
|
12
|
+
- you are not allowed to copy, duplicate, modify, adapt and translate this software except as authorized under section L122-6-1 of the French Intellectual Property Code or specifically under the specific agreement with Cosmo Tech;
|
|
13
|
+
- you must not removed this notice or any mention related to the copyright of Cosmo Tech;
|
|
14
|
+
|
|
15
|
+
This software is provided 'as is', without any express or implied warranty towards the users.
|
|
16
|
+
|
|
17
|
+
Any Software generated through the use of the software shall be your own property to the extent this Software does not contain any part of software source code.
|
|
@@ -0,0 +1,207 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: cosmotech.asset_data_layer_client
|
|
3
|
+
Version: 0.2.0rc1
|
|
4
|
+
Summary: Asset Data Layer
|
|
5
|
+
Home-page:
|
|
6
|
+
Author: OpenAPI Generator community
|
|
7
|
+
Author-email: OpenAPI Generator Community <team@openapitools.org>
|
|
8
|
+
Project-URL: Repository, https://github.com/GIT_USER_ID/GIT_REPO_ID
|
|
9
|
+
Keywords: OpenAPI,OpenAPI-Generator,Asset Data Layer
|
|
10
|
+
Requires-Python: >=3.10
|
|
11
|
+
Description-Content-Type: text/markdown
|
|
12
|
+
License-File: LICENSE
|
|
13
|
+
Requires-Dist: urllib3<3.0.0,>=2.7.0
|
|
14
|
+
Requires-Dist: python-dateutil>=2.8.2
|
|
15
|
+
Requires-Dist: pydantic>=2.11
|
|
16
|
+
Requires-Dist: typing-extensions>=4.7.1
|
|
17
|
+
Dynamic: author
|
|
18
|
+
Dynamic: license-file
|
|
19
|
+
|
|
20
|
+
# cosmotech-asset-data-layer-client
|
|
21
|
+
API for Asset Data Layer
|
|
22
|
+
|
|
23
|
+
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
24
|
+
|
|
25
|
+
- API version: 1.0.0
|
|
26
|
+
- Package version: 0.2.0-rc1
|
|
27
|
+
- Generator version: 7.26.0
|
|
28
|
+
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
|
|
29
|
+
|
|
30
|
+
## Requirements.
|
|
31
|
+
|
|
32
|
+
Python 3.10+
|
|
33
|
+
|
|
34
|
+
Packaging uses standard `[project]` metadata and `[dependency-groups]` (PEP 621/735).
|
|
35
|
+
Install the package with `python -m pip install .`; install development dependencies
|
|
36
|
+
with Poetry 2.2 or newer using `poetry install`, or pip 25.1 or newer using
|
|
37
|
+
`python -m pip install --group dev`. The latter installs the group, not the package.
|
|
38
|
+
|
|
39
|
+
## Installation & Usage
|
|
40
|
+
### pip install
|
|
41
|
+
|
|
42
|
+
If the python package is hosted on a repository, you can install directly using:
|
|
43
|
+
|
|
44
|
+
```sh
|
|
45
|
+
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
|
|
46
|
+
```
|
|
47
|
+
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
|
|
48
|
+
|
|
49
|
+
Then import the package:
|
|
50
|
+
```python
|
|
51
|
+
import cosmotech.asset_data_layer_client
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
### Setuptools
|
|
55
|
+
|
|
56
|
+
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
|
|
57
|
+
|
|
58
|
+
```sh
|
|
59
|
+
python setup.py install --user
|
|
60
|
+
```
|
|
61
|
+
(or `sudo python setup.py install` to install the package for all users)
|
|
62
|
+
|
|
63
|
+
Then import the package:
|
|
64
|
+
```python
|
|
65
|
+
import cosmotech.asset_data_layer_client
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
### Tests
|
|
69
|
+
|
|
70
|
+
Execute `pytest` to run the tests.
|
|
71
|
+
|
|
72
|
+
## Getting Started
|
|
73
|
+
|
|
74
|
+
Please follow the [installation procedure](#installation--usage) and then run the following:
|
|
75
|
+
|
|
76
|
+
```python
|
|
77
|
+
|
|
78
|
+
import cosmotech.asset_data_layer_client
|
|
79
|
+
from cosmotech.asset_data_layer_client.rest import ApiException
|
|
80
|
+
from pprint import pprint
|
|
81
|
+
|
|
82
|
+
# Defining the host is optional and defaults to http://localhost
|
|
83
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
84
|
+
configuration = cosmotech.asset_data_layer_client.Configuration(
|
|
85
|
+
host = "http://localhost"
|
|
86
|
+
)
|
|
87
|
+
|
|
88
|
+
# The client must configure the authentication and authorization parameters
|
|
89
|
+
# in accordance with the API server security policy.
|
|
90
|
+
# Examples for each auth method are provided below, use the example that
|
|
91
|
+
# satisfies your auth use case.
|
|
92
|
+
|
|
93
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
# Enter a context with an instance of the API client
|
|
97
|
+
with cosmotech.asset_data_layer_client.ApiClient(configuration) as api_client:
|
|
98
|
+
# Create an instance of the API class
|
|
99
|
+
api_instance = cosmotech.asset_data_layer_client.CSMAPIApi(api_client)
|
|
100
|
+
offset = 0 # int | Number of records to skip (optional) (default to 0)
|
|
101
|
+
limit = 100 # int | Max number of records to return (optional) (default to 100)
|
|
102
|
+
|
|
103
|
+
try:
|
|
104
|
+
# List csm organizations
|
|
105
|
+
api_response = api_instance.list_csm_organizations_csm_organizations_get(offset=offset, limit=limit)
|
|
106
|
+
print("The response of CSMAPIApi->list_csm_organizations_csm_organizations_get:\n")
|
|
107
|
+
pprint(api_response)
|
|
108
|
+
except ApiException as e:
|
|
109
|
+
print("Exception when calling CSMAPIApi->list_csm_organizations_csm_organizations_get: %s\n" % e)
|
|
110
|
+
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
## Documentation for API Endpoints
|
|
114
|
+
|
|
115
|
+
All URIs are relative to *http://localhost*
|
|
116
|
+
|
|
117
|
+
Class | Method | HTTP request | Description
|
|
118
|
+
------------ | ------------- | ------------- | -------------
|
|
119
|
+
*CSMAPIApi* | [**list_csm_organizations_csm_organizations_get**](docs/CSMAPIApi.md#list_csm_organizations_csm_organizations_get) | **GET** /csm/organizations | List csm organizations
|
|
120
|
+
*DatasetsApi* | [**create_dataset**](docs/DatasetsApi.md#create_dataset) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/datasets | Create a dataset
|
|
121
|
+
*DatasetsApi* | [**create_dataset_access**](docs/DatasetsApi.md#create_dataset_access) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security/access | Share a dataset with a user or group
|
|
122
|
+
*DatasetsApi* | [**delete_dataset**](docs/DatasetsApi.md#delete_dataset) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id} | Delete a dataset
|
|
123
|
+
*DatasetsApi* | [**delete_dataset_access**](docs/DatasetsApi.md#delete_dataset_access) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security/access/{identity_id} | Revoke a dataset access
|
|
124
|
+
*DatasetsApi* | [**delete_dataset_file**](docs/DatasetsApi.md#delete_dataset_file) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/files/{file_name} | Delete a file from a dataset
|
|
125
|
+
*DatasetsApi* | [**download_dataset**](docs/DatasetsApi.md#download_dataset) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/archive | Download a whole dataset as a zip file
|
|
126
|
+
*DatasetsApi* | [**download_transformed_dataset**](docs/DatasetsApi.md#download_transformed_dataset) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/transformed-data | Download the transformed dataset, waiting for the transformation
|
|
127
|
+
*DatasetsApi* | [**get_dataset**](docs/DatasetsApi.md#get_dataset) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id} | Get a dataset (detailed view)
|
|
128
|
+
*DatasetsApi* | [**get_dataset_security**](docs/DatasetsApi.md#get_dataset_security) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security | Get the security of a dataset
|
|
129
|
+
*DatasetsApi* | [**get_dataset_transformation_status**](docs/DatasetsApi.md#get_dataset_transformation_status) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/transformation-status | Read a dataset's latest transformation state
|
|
130
|
+
*DatasetsApi* | [**get_dataset_validation_status**](docs/DatasetsApi.md#get_dataset_validation_status) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/validation-status | Read a dataset's latest validation result
|
|
131
|
+
*DatasetsApi* | [**get_file**](docs/DatasetsApi.md#get_file) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/files/{file_path} | Get a file from a dataset
|
|
132
|
+
*DatasetsApi* | [**list_datasets**](docs/DatasetsApi.md#list_datasets) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets | List datasets (listing view)
|
|
133
|
+
*DatasetsApi* | [**transform_dataset**](docs/DatasetsApi.md#transform_dataset) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/transform | Start transforming a validated dataset
|
|
134
|
+
*DatasetsApi* | [**update_dataset**](docs/DatasetsApi.md#update_dataset) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id} | Update a dataset's metadata
|
|
135
|
+
*DatasetsApi* | [**update_dataset_access**](docs/DatasetsApi.md#update_dataset_access) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security/access/{identity_id} | Change the role of a dataset access
|
|
136
|
+
*DatasetsApi* | [**upload_dataset_data**](docs/DatasetsApi.md#upload_dataset_data) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/data | Upload data into an existing dataset
|
|
137
|
+
*DatasetsApi* | [**validate_dataset**](docs/DatasetsApi.md#validate_dataset) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/validate | Start validating a dataset's uploaded data
|
|
138
|
+
*RunnersApi* | [**get_runner**](docs/RunnersApi.md#get_runner) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id} | Get runner
|
|
139
|
+
*RunnersApi* | [**list_runners**](docs/RunnersApi.md#list_runners) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners | List runners
|
|
140
|
+
*RunnersApi* | [**update_runner**](docs/RunnersApi.md#update_runner) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id} | Update runner
|
|
141
|
+
*ScenariosApi* | [**create_scenario**](docs/ScenariosApi.md#create_scenario) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/scenarios | Create a scenario of a dataset, and its runner
|
|
142
|
+
*ScenariosApi* | [**delete_scenario**](docs/ScenariosApi.md#delete_scenario) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/scenarios/{runner_id} | Delete a scenario, its children, their editions and their runners
|
|
143
|
+
*ScenariosApi* | [**download_scenario_table**](docs/ScenariosApi.md#download_scenario_table) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/scenarios/{runner_id}/tables/{table_name} | Download the scenario's current version of one table, for editing
|
|
144
|
+
*ScenariosApi* | [**download_transformed_scenario**](docs/ScenariosApi.md#download_transformed_scenario) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/scenarios/{runner_id}/transformed-data | Download the scenario's transformed dataset, transforming it if needed
|
|
145
|
+
*ScenariosApi* | [**get_scenario**](docs/ScenariosApi.md#get_scenario) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/scenarios/{runner_id} | Get a scenario, its editions and its validation state
|
|
146
|
+
*ScenariosApi* | [**revert_scenario_table**](docs/ScenariosApi.md#revert_scenario_table) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/scenarios/{runner_id}/tables/{table_name} | Drop the scenario's own edits of one table
|
|
147
|
+
*ScenariosApi* | [**transform_scenario**](docs/ScenariosApi.md#transform_scenario) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/scenarios/{runner_id}/transform | Transform the scenario's validated edited dataset
|
|
148
|
+
*ScenariosApi* | [**upload_scenario_table**](docs/ScenariosApi.md#upload_scenario_table) | **PUT** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/scenarios/{runner_id}/tables/{table_name} | Upload an edited table; only its diff against the parent is stored
|
|
149
|
+
*ScenariosApi* | [**validate_scenario**](docs/ScenariosApi.md#validate_scenario) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/scenarios/{runner_id}/validate | Validate the scenario's whole edited dataset
|
|
150
|
+
*DefaultApi* | [**root**](docs/DefaultApi.md#root) | **GET** /about | Root
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
## Documentation For Models
|
|
154
|
+
|
|
155
|
+
- [DatasetAccessCreateRequest](docs/DatasetAccessCreateRequest.md)
|
|
156
|
+
- [DatasetAccessResponse](docs/DatasetAccessResponse.md)
|
|
157
|
+
- [DatasetAccessUpdateRequest](docs/DatasetAccessUpdateRequest.md)
|
|
158
|
+
- [DatasetDetailResponse](docs/DatasetDetailResponse.md)
|
|
159
|
+
- [DatasetFileResponse](docs/DatasetFileResponse.md)
|
|
160
|
+
- [DatasetListItemResponse](docs/DatasetListItemResponse.md)
|
|
161
|
+
- [DatasetRole](docs/DatasetRole.md)
|
|
162
|
+
- [DatasetScenarioResponse](docs/DatasetScenarioResponse.md)
|
|
163
|
+
- [DatasetSecurityResponse](docs/DatasetSecurityResponse.md)
|
|
164
|
+
- [DatasetStatus](docs/DatasetStatus.md)
|
|
165
|
+
- [DatasetTransformationStatusResponse](docs/DatasetTransformationStatusResponse.md)
|
|
166
|
+
- [DatasetValidationDiagnosticResponse](docs/DatasetValidationDiagnosticResponse.md)
|
|
167
|
+
- [DatasetValidationStatusResponse](docs/DatasetValidationStatusResponse.md)
|
|
168
|
+
- [HTTPValidationError](docs/HTTPValidationError.md)
|
|
169
|
+
- [LocationInner](docs/LocationInner.md)
|
|
170
|
+
- [Metadata](docs/Metadata.md)
|
|
171
|
+
- [ResourceSizeInfo](docs/ResourceSizeInfo.md)
|
|
172
|
+
- [RunTiming](docs/RunTiming.md)
|
|
173
|
+
- [RunTimingNode](docs/RunTimingNode.md)
|
|
174
|
+
- [RunTimingStep](docs/RunTimingStep.md)
|
|
175
|
+
- [RunnerListItemResponse](docs/RunnerListItemResponse.md)
|
|
176
|
+
- [RunnerResourceSizing](docs/RunnerResourceSizing.md)
|
|
177
|
+
- [RunnerResponse](docs/RunnerResponse.md)
|
|
178
|
+
- [RunnerRunTemplateParameterValue](docs/RunnerRunTemplateParameterValue.md)
|
|
179
|
+
- [RunnerUpdateRequest](docs/RunnerUpdateRequest.md)
|
|
180
|
+
- [RunnerValidationStatus](docs/RunnerValidationStatus.md)
|
|
181
|
+
- [ScenarioCreateRequest](docs/ScenarioCreateRequest.md)
|
|
182
|
+
- [ScenarioDiagnosticResponse](docs/ScenarioDiagnosticResponse.md)
|
|
183
|
+
- [ScenarioEditionResponse](docs/ScenarioEditionResponse.md)
|
|
184
|
+
- [ScenarioResponse](docs/ScenarioResponse.md)
|
|
185
|
+
- [ScenarioState](docs/ScenarioState.md)
|
|
186
|
+
- [ScenarioTransformationResponse](docs/ScenarioTransformationResponse.md)
|
|
187
|
+
- [ValidationError](docs/ValidationError.md)
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
<a id="documentation-for-authorization"></a>
|
|
191
|
+
## Documentation For Authorization
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
Authentication schemes defined for the API:
|
|
195
|
+
<a id="OAuth2AuthorizationCodeBearer"></a>
|
|
196
|
+
### OAuth2AuthorizationCodeBearer
|
|
197
|
+
|
|
198
|
+
- **Type**: OAuth
|
|
199
|
+
- **Flow**: accessCode
|
|
200
|
+
- **Authorization URL**: /protocol/openid-connect/auth
|
|
201
|
+
- **Scopes**: N/A
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
## Author
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
@@ -0,0 +1,188 @@
|
|
|
1
|
+
# cosmotech-asset-data-layer-client
|
|
2
|
+
API for Asset Data Layer
|
|
3
|
+
|
|
4
|
+
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
5
|
+
|
|
6
|
+
- API version: 1.0.0
|
|
7
|
+
- Package version: 0.2.0-rc1
|
|
8
|
+
- Generator version: 7.26.0
|
|
9
|
+
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
|
|
10
|
+
|
|
11
|
+
## Requirements.
|
|
12
|
+
|
|
13
|
+
Python 3.10+
|
|
14
|
+
|
|
15
|
+
Packaging uses standard `[project]` metadata and `[dependency-groups]` (PEP 621/735).
|
|
16
|
+
Install the package with `python -m pip install .`; install development dependencies
|
|
17
|
+
with Poetry 2.2 or newer using `poetry install`, or pip 25.1 or newer using
|
|
18
|
+
`python -m pip install --group dev`. The latter installs the group, not the package.
|
|
19
|
+
|
|
20
|
+
## Installation & Usage
|
|
21
|
+
### pip install
|
|
22
|
+
|
|
23
|
+
If the python package is hosted on a repository, you can install directly using:
|
|
24
|
+
|
|
25
|
+
```sh
|
|
26
|
+
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
|
|
27
|
+
```
|
|
28
|
+
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
|
|
29
|
+
|
|
30
|
+
Then import the package:
|
|
31
|
+
```python
|
|
32
|
+
import cosmotech.asset_data_layer_client
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### Setuptools
|
|
36
|
+
|
|
37
|
+
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
|
|
38
|
+
|
|
39
|
+
```sh
|
|
40
|
+
python setup.py install --user
|
|
41
|
+
```
|
|
42
|
+
(or `sudo python setup.py install` to install the package for all users)
|
|
43
|
+
|
|
44
|
+
Then import the package:
|
|
45
|
+
```python
|
|
46
|
+
import cosmotech.asset_data_layer_client
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
### Tests
|
|
50
|
+
|
|
51
|
+
Execute `pytest` to run the tests.
|
|
52
|
+
|
|
53
|
+
## Getting Started
|
|
54
|
+
|
|
55
|
+
Please follow the [installation procedure](#installation--usage) and then run the following:
|
|
56
|
+
|
|
57
|
+
```python
|
|
58
|
+
|
|
59
|
+
import cosmotech.asset_data_layer_client
|
|
60
|
+
from cosmotech.asset_data_layer_client.rest import ApiException
|
|
61
|
+
from pprint import pprint
|
|
62
|
+
|
|
63
|
+
# Defining the host is optional and defaults to http://localhost
|
|
64
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
65
|
+
configuration = cosmotech.asset_data_layer_client.Configuration(
|
|
66
|
+
host = "http://localhost"
|
|
67
|
+
)
|
|
68
|
+
|
|
69
|
+
# The client must configure the authentication and authorization parameters
|
|
70
|
+
# in accordance with the API server security policy.
|
|
71
|
+
# Examples for each auth method are provided below, use the example that
|
|
72
|
+
# satisfies your auth use case.
|
|
73
|
+
|
|
74
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
# Enter a context with an instance of the API client
|
|
78
|
+
with cosmotech.asset_data_layer_client.ApiClient(configuration) as api_client:
|
|
79
|
+
# Create an instance of the API class
|
|
80
|
+
api_instance = cosmotech.asset_data_layer_client.CSMAPIApi(api_client)
|
|
81
|
+
offset = 0 # int | Number of records to skip (optional) (default to 0)
|
|
82
|
+
limit = 100 # int | Max number of records to return (optional) (default to 100)
|
|
83
|
+
|
|
84
|
+
try:
|
|
85
|
+
# List csm organizations
|
|
86
|
+
api_response = api_instance.list_csm_organizations_csm_organizations_get(offset=offset, limit=limit)
|
|
87
|
+
print("The response of CSMAPIApi->list_csm_organizations_csm_organizations_get:\n")
|
|
88
|
+
pprint(api_response)
|
|
89
|
+
except ApiException as e:
|
|
90
|
+
print("Exception when calling CSMAPIApi->list_csm_organizations_csm_organizations_get: %s\n" % e)
|
|
91
|
+
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
## Documentation for API Endpoints
|
|
95
|
+
|
|
96
|
+
All URIs are relative to *http://localhost*
|
|
97
|
+
|
|
98
|
+
Class | Method | HTTP request | Description
|
|
99
|
+
------------ | ------------- | ------------- | -------------
|
|
100
|
+
*CSMAPIApi* | [**list_csm_organizations_csm_organizations_get**](docs/CSMAPIApi.md#list_csm_organizations_csm_organizations_get) | **GET** /csm/organizations | List csm organizations
|
|
101
|
+
*DatasetsApi* | [**create_dataset**](docs/DatasetsApi.md#create_dataset) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/datasets | Create a dataset
|
|
102
|
+
*DatasetsApi* | [**create_dataset_access**](docs/DatasetsApi.md#create_dataset_access) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security/access | Share a dataset with a user or group
|
|
103
|
+
*DatasetsApi* | [**delete_dataset**](docs/DatasetsApi.md#delete_dataset) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id} | Delete a dataset
|
|
104
|
+
*DatasetsApi* | [**delete_dataset_access**](docs/DatasetsApi.md#delete_dataset_access) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security/access/{identity_id} | Revoke a dataset access
|
|
105
|
+
*DatasetsApi* | [**delete_dataset_file**](docs/DatasetsApi.md#delete_dataset_file) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/files/{file_name} | Delete a file from a dataset
|
|
106
|
+
*DatasetsApi* | [**download_dataset**](docs/DatasetsApi.md#download_dataset) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/archive | Download a whole dataset as a zip file
|
|
107
|
+
*DatasetsApi* | [**download_transformed_dataset**](docs/DatasetsApi.md#download_transformed_dataset) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/transformed-data | Download the transformed dataset, waiting for the transformation
|
|
108
|
+
*DatasetsApi* | [**get_dataset**](docs/DatasetsApi.md#get_dataset) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id} | Get a dataset (detailed view)
|
|
109
|
+
*DatasetsApi* | [**get_dataset_security**](docs/DatasetsApi.md#get_dataset_security) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security | Get the security of a dataset
|
|
110
|
+
*DatasetsApi* | [**get_dataset_transformation_status**](docs/DatasetsApi.md#get_dataset_transformation_status) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/transformation-status | Read a dataset's latest transformation state
|
|
111
|
+
*DatasetsApi* | [**get_dataset_validation_status**](docs/DatasetsApi.md#get_dataset_validation_status) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/validation-status | Read a dataset's latest validation result
|
|
112
|
+
*DatasetsApi* | [**get_file**](docs/DatasetsApi.md#get_file) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/files/{file_path} | Get a file from a dataset
|
|
113
|
+
*DatasetsApi* | [**list_datasets**](docs/DatasetsApi.md#list_datasets) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets | List datasets (listing view)
|
|
114
|
+
*DatasetsApi* | [**transform_dataset**](docs/DatasetsApi.md#transform_dataset) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/transform | Start transforming a validated dataset
|
|
115
|
+
*DatasetsApi* | [**update_dataset**](docs/DatasetsApi.md#update_dataset) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id} | Update a dataset's metadata
|
|
116
|
+
*DatasetsApi* | [**update_dataset_access**](docs/DatasetsApi.md#update_dataset_access) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security/access/{identity_id} | Change the role of a dataset access
|
|
117
|
+
*DatasetsApi* | [**upload_dataset_data**](docs/DatasetsApi.md#upload_dataset_data) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/data | Upload data into an existing dataset
|
|
118
|
+
*DatasetsApi* | [**validate_dataset**](docs/DatasetsApi.md#validate_dataset) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/validate | Start validating a dataset's uploaded data
|
|
119
|
+
*RunnersApi* | [**get_runner**](docs/RunnersApi.md#get_runner) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id} | Get runner
|
|
120
|
+
*RunnersApi* | [**list_runners**](docs/RunnersApi.md#list_runners) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners | List runners
|
|
121
|
+
*RunnersApi* | [**update_runner**](docs/RunnersApi.md#update_runner) | **PATCH** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id} | Update runner
|
|
122
|
+
*ScenariosApi* | [**create_scenario**](docs/ScenariosApi.md#create_scenario) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/scenarios | Create a scenario of a dataset, and its runner
|
|
123
|
+
*ScenariosApi* | [**delete_scenario**](docs/ScenariosApi.md#delete_scenario) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/scenarios/{runner_id} | Delete a scenario, its children, their editions and their runners
|
|
124
|
+
*ScenariosApi* | [**download_scenario_table**](docs/ScenariosApi.md#download_scenario_table) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/scenarios/{runner_id}/tables/{table_name} | Download the scenario's current version of one table, for editing
|
|
125
|
+
*ScenariosApi* | [**download_transformed_scenario**](docs/ScenariosApi.md#download_transformed_scenario) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/scenarios/{runner_id}/transformed-data | Download the scenario's transformed dataset, transforming it if needed
|
|
126
|
+
*ScenariosApi* | [**get_scenario**](docs/ScenariosApi.md#get_scenario) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/scenarios/{runner_id} | Get a scenario, its editions and its validation state
|
|
127
|
+
*ScenariosApi* | [**revert_scenario_table**](docs/ScenariosApi.md#revert_scenario_table) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/scenarios/{runner_id}/tables/{table_name} | Drop the scenario's own edits of one table
|
|
128
|
+
*ScenariosApi* | [**transform_scenario**](docs/ScenariosApi.md#transform_scenario) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/scenarios/{runner_id}/transform | Transform the scenario's validated edited dataset
|
|
129
|
+
*ScenariosApi* | [**upload_scenario_table**](docs/ScenariosApi.md#upload_scenario_table) | **PUT** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/scenarios/{runner_id}/tables/{table_name} | Upload an edited table; only its diff against the parent is stored
|
|
130
|
+
*ScenariosApi* | [**validate_scenario**](docs/ScenariosApi.md#validate_scenario) | **POST** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/scenarios/{runner_id}/validate | Validate the scenario's whole edited dataset
|
|
131
|
+
*DefaultApi* | [**root**](docs/DefaultApi.md#root) | **GET** /about | Root
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
## Documentation For Models
|
|
135
|
+
|
|
136
|
+
- [DatasetAccessCreateRequest](docs/DatasetAccessCreateRequest.md)
|
|
137
|
+
- [DatasetAccessResponse](docs/DatasetAccessResponse.md)
|
|
138
|
+
- [DatasetAccessUpdateRequest](docs/DatasetAccessUpdateRequest.md)
|
|
139
|
+
- [DatasetDetailResponse](docs/DatasetDetailResponse.md)
|
|
140
|
+
- [DatasetFileResponse](docs/DatasetFileResponse.md)
|
|
141
|
+
- [DatasetListItemResponse](docs/DatasetListItemResponse.md)
|
|
142
|
+
- [DatasetRole](docs/DatasetRole.md)
|
|
143
|
+
- [DatasetScenarioResponse](docs/DatasetScenarioResponse.md)
|
|
144
|
+
- [DatasetSecurityResponse](docs/DatasetSecurityResponse.md)
|
|
145
|
+
- [DatasetStatus](docs/DatasetStatus.md)
|
|
146
|
+
- [DatasetTransformationStatusResponse](docs/DatasetTransformationStatusResponse.md)
|
|
147
|
+
- [DatasetValidationDiagnosticResponse](docs/DatasetValidationDiagnosticResponse.md)
|
|
148
|
+
- [DatasetValidationStatusResponse](docs/DatasetValidationStatusResponse.md)
|
|
149
|
+
- [HTTPValidationError](docs/HTTPValidationError.md)
|
|
150
|
+
- [LocationInner](docs/LocationInner.md)
|
|
151
|
+
- [Metadata](docs/Metadata.md)
|
|
152
|
+
- [ResourceSizeInfo](docs/ResourceSizeInfo.md)
|
|
153
|
+
- [RunTiming](docs/RunTiming.md)
|
|
154
|
+
- [RunTimingNode](docs/RunTimingNode.md)
|
|
155
|
+
- [RunTimingStep](docs/RunTimingStep.md)
|
|
156
|
+
- [RunnerListItemResponse](docs/RunnerListItemResponse.md)
|
|
157
|
+
- [RunnerResourceSizing](docs/RunnerResourceSizing.md)
|
|
158
|
+
- [RunnerResponse](docs/RunnerResponse.md)
|
|
159
|
+
- [RunnerRunTemplateParameterValue](docs/RunnerRunTemplateParameterValue.md)
|
|
160
|
+
- [RunnerUpdateRequest](docs/RunnerUpdateRequest.md)
|
|
161
|
+
- [RunnerValidationStatus](docs/RunnerValidationStatus.md)
|
|
162
|
+
- [ScenarioCreateRequest](docs/ScenarioCreateRequest.md)
|
|
163
|
+
- [ScenarioDiagnosticResponse](docs/ScenarioDiagnosticResponse.md)
|
|
164
|
+
- [ScenarioEditionResponse](docs/ScenarioEditionResponse.md)
|
|
165
|
+
- [ScenarioResponse](docs/ScenarioResponse.md)
|
|
166
|
+
- [ScenarioState](docs/ScenarioState.md)
|
|
167
|
+
- [ScenarioTransformationResponse](docs/ScenarioTransformationResponse.md)
|
|
168
|
+
- [ValidationError](docs/ValidationError.md)
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
<a id="documentation-for-authorization"></a>
|
|
172
|
+
## Documentation For Authorization
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
Authentication schemes defined for the API:
|
|
176
|
+
<a id="OAuth2AuthorizationCodeBearer"></a>
|
|
177
|
+
### OAuth2AuthorizationCodeBearer
|
|
178
|
+
|
|
179
|
+
- **Type**: OAuth
|
|
180
|
+
- **Flow**: accessCode
|
|
181
|
+
- **Authorization URL**: /protocol/openid-connect/auth
|
|
182
|
+
- **Scopes**: N/A
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
## Author
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
File without changes
|
|
@@ -0,0 +1,187 @@
|
|
|
1
|
+
# coding: utf-8
|
|
2
|
+
|
|
3
|
+
# flake8: noqa
|
|
4
|
+
|
|
5
|
+
"""
|
|
6
|
+
Asset Data Layer
|
|
7
|
+
|
|
8
|
+
API for Asset Data Layer
|
|
9
|
+
|
|
10
|
+
The version of the OpenAPI document: 1.0.0
|
|
11
|
+
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
12
|
+
|
|
13
|
+
Do not edit the class manually.
|
|
14
|
+
""" # noqa: E501
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
__version__ = "0.2.0-rc1"
|
|
18
|
+
|
|
19
|
+
# Define package exports
|
|
20
|
+
__all__ = [
|
|
21
|
+
"CSMAPIApi",
|
|
22
|
+
"DatasetsApi",
|
|
23
|
+
"RunnersApi",
|
|
24
|
+
"ScenariosApi",
|
|
25
|
+
"DefaultApi",
|
|
26
|
+
"ApiResponse",
|
|
27
|
+
"ApiClient",
|
|
28
|
+
"Configuration",
|
|
29
|
+
"OpenApiException",
|
|
30
|
+
"ApiTypeError",
|
|
31
|
+
"ApiValueError",
|
|
32
|
+
"ApiKeyError",
|
|
33
|
+
"ApiAttributeError",
|
|
34
|
+
"ApiException",
|
|
35
|
+
"DatasetAccessCreateRequest",
|
|
36
|
+
"DatasetAccessResponse",
|
|
37
|
+
"DatasetAccessUpdateRequest",
|
|
38
|
+
"DatasetDetailResponse",
|
|
39
|
+
"DatasetFileResponse",
|
|
40
|
+
"DatasetListItemResponse",
|
|
41
|
+
"DatasetRole",
|
|
42
|
+
"DatasetScenarioResponse",
|
|
43
|
+
"DatasetSecurityResponse",
|
|
44
|
+
"DatasetStatus",
|
|
45
|
+
"DatasetTransformationStatusResponse",
|
|
46
|
+
"DatasetValidationDiagnosticResponse",
|
|
47
|
+
"DatasetValidationStatusResponse",
|
|
48
|
+
"HTTPValidationError",
|
|
49
|
+
"LocationInner",
|
|
50
|
+
"Metadata",
|
|
51
|
+
"ResourceSizeInfo",
|
|
52
|
+
"RunTiming",
|
|
53
|
+
"RunTimingNode",
|
|
54
|
+
"RunTimingStep",
|
|
55
|
+
"RunnerListItemResponse",
|
|
56
|
+
"RunnerResourceSizing",
|
|
57
|
+
"RunnerResponse",
|
|
58
|
+
"RunnerRunTemplateParameterValue",
|
|
59
|
+
"RunnerUpdateRequest",
|
|
60
|
+
"RunnerValidationStatus",
|
|
61
|
+
"ScenarioCreateRequest",
|
|
62
|
+
"ScenarioDiagnosticResponse",
|
|
63
|
+
"ScenarioEditionResponse",
|
|
64
|
+
"ScenarioResponse",
|
|
65
|
+
"ScenarioState",
|
|
66
|
+
"ScenarioTransformationResponse",
|
|
67
|
+
"ValidationError",
|
|
68
|
+
]
|
|
69
|
+
|
|
70
|
+
import typing as _typing
|
|
71
|
+
|
|
72
|
+
if _typing.TYPE_CHECKING:
|
|
73
|
+
# import apis into sdk package
|
|
74
|
+
from cosmotech.asset_data_layer_client.api.csmapi_api import CSMAPIApi as CSMAPIApi
|
|
75
|
+
from cosmotech.asset_data_layer_client.api.datasets_api import DatasetsApi as DatasetsApi
|
|
76
|
+
from cosmotech.asset_data_layer_client.api.runners_api import RunnersApi as RunnersApi
|
|
77
|
+
from cosmotech.asset_data_layer_client.api.scenarios_api import ScenariosApi as ScenariosApi
|
|
78
|
+
from cosmotech.asset_data_layer_client.api.default_api import DefaultApi as DefaultApi
|
|
79
|
+
|
|
80
|
+
# import ApiClient
|
|
81
|
+
from cosmotech.asset_data_layer_client.api_response import ApiResponse as ApiResponse
|
|
82
|
+
from cosmotech.asset_data_layer_client.api_client import ApiClient as ApiClient
|
|
83
|
+
from cosmotech.asset_data_layer_client.configuration import Configuration as Configuration
|
|
84
|
+
from cosmotech.asset_data_layer_client.exceptions import OpenApiException as OpenApiException
|
|
85
|
+
from cosmotech.asset_data_layer_client.exceptions import ApiTypeError as ApiTypeError
|
|
86
|
+
from cosmotech.asset_data_layer_client.exceptions import ApiValueError as ApiValueError
|
|
87
|
+
from cosmotech.asset_data_layer_client.exceptions import ApiKeyError as ApiKeyError
|
|
88
|
+
from cosmotech.asset_data_layer_client.exceptions import ApiAttributeError as ApiAttributeError
|
|
89
|
+
from cosmotech.asset_data_layer_client.exceptions import ApiException as ApiException
|
|
90
|
+
|
|
91
|
+
# import models into sdk package
|
|
92
|
+
from cosmotech.asset_data_layer_client.models.dataset_access_create_request import DatasetAccessCreateRequest as DatasetAccessCreateRequest
|
|
93
|
+
from cosmotech.asset_data_layer_client.models.dataset_access_response import DatasetAccessResponse as DatasetAccessResponse
|
|
94
|
+
from cosmotech.asset_data_layer_client.models.dataset_access_update_request import DatasetAccessUpdateRequest as DatasetAccessUpdateRequest
|
|
95
|
+
from cosmotech.asset_data_layer_client.models.dataset_detail_response import DatasetDetailResponse as DatasetDetailResponse
|
|
96
|
+
from cosmotech.asset_data_layer_client.models.dataset_file_response import DatasetFileResponse as DatasetFileResponse
|
|
97
|
+
from cosmotech.asset_data_layer_client.models.dataset_list_item_response import DatasetListItemResponse as DatasetListItemResponse
|
|
98
|
+
from cosmotech.asset_data_layer_client.models.dataset_role import DatasetRole as DatasetRole
|
|
99
|
+
from cosmotech.asset_data_layer_client.models.dataset_scenario_response import DatasetScenarioResponse as DatasetScenarioResponse
|
|
100
|
+
from cosmotech.asset_data_layer_client.models.dataset_security_response import DatasetSecurityResponse as DatasetSecurityResponse
|
|
101
|
+
from cosmotech.asset_data_layer_client.models.dataset_status import DatasetStatus as DatasetStatus
|
|
102
|
+
from cosmotech.asset_data_layer_client.models.dataset_transformation_status_response import DatasetTransformationStatusResponse as DatasetTransformationStatusResponse
|
|
103
|
+
from cosmotech.asset_data_layer_client.models.dataset_validation_diagnostic_response import DatasetValidationDiagnosticResponse as DatasetValidationDiagnosticResponse
|
|
104
|
+
from cosmotech.asset_data_layer_client.models.dataset_validation_status_response import DatasetValidationStatusResponse as DatasetValidationStatusResponse
|
|
105
|
+
from cosmotech.asset_data_layer_client.models.http_validation_error import HTTPValidationError as HTTPValidationError
|
|
106
|
+
from cosmotech.asset_data_layer_client.models.location_inner import LocationInner as LocationInner
|
|
107
|
+
from cosmotech.asset_data_layer_client.models.metadata import Metadata as Metadata
|
|
108
|
+
from cosmotech.asset_data_layer_client.models.resource_size_info import ResourceSizeInfo as ResourceSizeInfo
|
|
109
|
+
from cosmotech.asset_data_layer_client.models.run_timing import RunTiming as RunTiming
|
|
110
|
+
from cosmotech.asset_data_layer_client.models.run_timing_node import RunTimingNode as RunTimingNode
|
|
111
|
+
from cosmotech.asset_data_layer_client.models.run_timing_step import RunTimingStep as RunTimingStep
|
|
112
|
+
from cosmotech.asset_data_layer_client.models.runner_list_item_response import RunnerListItemResponse as RunnerListItemResponse
|
|
113
|
+
from cosmotech.asset_data_layer_client.models.runner_resource_sizing import RunnerResourceSizing as RunnerResourceSizing
|
|
114
|
+
from cosmotech.asset_data_layer_client.models.runner_response import RunnerResponse as RunnerResponse
|
|
115
|
+
from cosmotech.asset_data_layer_client.models.runner_run_template_parameter_value import RunnerRunTemplateParameterValue as RunnerRunTemplateParameterValue
|
|
116
|
+
from cosmotech.asset_data_layer_client.models.runner_update_request import RunnerUpdateRequest as RunnerUpdateRequest
|
|
117
|
+
from cosmotech.asset_data_layer_client.models.runner_validation_status import RunnerValidationStatus as RunnerValidationStatus
|
|
118
|
+
from cosmotech.asset_data_layer_client.models.scenario_create_request import ScenarioCreateRequest as ScenarioCreateRequest
|
|
119
|
+
from cosmotech.asset_data_layer_client.models.scenario_diagnostic_response import ScenarioDiagnosticResponse as ScenarioDiagnosticResponse
|
|
120
|
+
from cosmotech.asset_data_layer_client.models.scenario_edition_response import ScenarioEditionResponse as ScenarioEditionResponse
|
|
121
|
+
from cosmotech.asset_data_layer_client.models.scenario_response import ScenarioResponse as ScenarioResponse
|
|
122
|
+
from cosmotech.asset_data_layer_client.models.scenario_state import ScenarioState as ScenarioState
|
|
123
|
+
from cosmotech.asset_data_layer_client.models.scenario_transformation_response import ScenarioTransformationResponse as ScenarioTransformationResponse
|
|
124
|
+
from cosmotech.asset_data_layer_client.models.validation_error import ValidationError as ValidationError
|
|
125
|
+
|
|
126
|
+
else:
|
|
127
|
+
from importlib import import_module
|
|
128
|
+
|
|
129
|
+
_exports = {
|
|
130
|
+
"CSMAPIApi": ".api.csmapi_api",
|
|
131
|
+
"DatasetsApi": ".api.datasets_api",
|
|
132
|
+
"RunnersApi": ".api.runners_api",
|
|
133
|
+
"ScenariosApi": ".api.scenarios_api",
|
|
134
|
+
"DefaultApi": ".api.default_api",
|
|
135
|
+
"ApiResponse": ".api_response",
|
|
136
|
+
"ApiClient": ".api_client",
|
|
137
|
+
"Configuration": ".configuration",
|
|
138
|
+
"OpenApiException": ".exceptions",
|
|
139
|
+
"ApiTypeError": ".exceptions",
|
|
140
|
+
"ApiValueError": ".exceptions",
|
|
141
|
+
"ApiKeyError": ".exceptions",
|
|
142
|
+
"ApiAttributeError": ".exceptions",
|
|
143
|
+
"ApiException": ".exceptions",
|
|
144
|
+
"DatasetAccessCreateRequest": ".models.dataset_access_create_request",
|
|
145
|
+
"DatasetAccessResponse": ".models.dataset_access_response",
|
|
146
|
+
"DatasetAccessUpdateRequest": ".models.dataset_access_update_request",
|
|
147
|
+
"DatasetDetailResponse": ".models.dataset_detail_response",
|
|
148
|
+
"DatasetFileResponse": ".models.dataset_file_response",
|
|
149
|
+
"DatasetListItemResponse": ".models.dataset_list_item_response",
|
|
150
|
+
"DatasetRole": ".models.dataset_role",
|
|
151
|
+
"DatasetScenarioResponse": ".models.dataset_scenario_response",
|
|
152
|
+
"DatasetSecurityResponse": ".models.dataset_security_response",
|
|
153
|
+
"DatasetStatus": ".models.dataset_status",
|
|
154
|
+
"DatasetTransformationStatusResponse": ".models.dataset_transformation_status_response",
|
|
155
|
+
"DatasetValidationDiagnosticResponse": ".models.dataset_validation_diagnostic_response",
|
|
156
|
+
"DatasetValidationStatusResponse": ".models.dataset_validation_status_response",
|
|
157
|
+
"HTTPValidationError": ".models.http_validation_error",
|
|
158
|
+
"LocationInner": ".models.location_inner",
|
|
159
|
+
"Metadata": ".models.metadata",
|
|
160
|
+
"ResourceSizeInfo": ".models.resource_size_info",
|
|
161
|
+
"RunTiming": ".models.run_timing",
|
|
162
|
+
"RunTimingNode": ".models.run_timing_node",
|
|
163
|
+
"RunTimingStep": ".models.run_timing_step",
|
|
164
|
+
"RunnerListItemResponse": ".models.runner_list_item_response",
|
|
165
|
+
"RunnerResourceSizing": ".models.runner_resource_sizing",
|
|
166
|
+
"RunnerResponse": ".models.runner_response",
|
|
167
|
+
"RunnerRunTemplateParameterValue": ".models.runner_run_template_parameter_value",
|
|
168
|
+
"RunnerUpdateRequest": ".models.runner_update_request",
|
|
169
|
+
"RunnerValidationStatus": ".models.runner_validation_status",
|
|
170
|
+
"ScenarioCreateRequest": ".models.scenario_create_request",
|
|
171
|
+
"ScenarioDiagnosticResponse": ".models.scenario_diagnostic_response",
|
|
172
|
+
"ScenarioEditionResponse": ".models.scenario_edition_response",
|
|
173
|
+
"ScenarioResponse": ".models.scenario_response",
|
|
174
|
+
"ScenarioState": ".models.scenario_state",
|
|
175
|
+
"ScenarioTransformationResponse": ".models.scenario_transformation_response",
|
|
176
|
+
"ValidationError": ".models.validation_error",
|
|
177
|
+
}
|
|
178
|
+
|
|
179
|
+
def __getattr__(name: str) -> object:
|
|
180
|
+
if (module_name := _exports.get(name)) is None:
|
|
181
|
+
raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
|
|
182
|
+
value = getattr(import_module(module_name, __name__), name)
|
|
183
|
+
globals()[name] = value
|
|
184
|
+
return value
|
|
185
|
+
|
|
186
|
+
def __dir__() -> list[str]:
|
|
187
|
+
return sorted(globals().keys() | _exports.keys())
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# flake8: noqa
|
|
2
|
+
|
|
3
|
+
__all__ = [
|
|
4
|
+
"CSMAPIApi",
|
|
5
|
+
"DatasetsApi",
|
|
6
|
+
"RunnersApi",
|
|
7
|
+
"ScenariosApi",
|
|
8
|
+
"DefaultApi",
|
|
9
|
+
]
|
|
10
|
+
|
|
11
|
+
import typing as _typing
|
|
12
|
+
|
|
13
|
+
if _typing.TYPE_CHECKING:
|
|
14
|
+
# import apis into api package
|
|
15
|
+
from cosmotech.asset_data_layer_client.api.csmapi_api import CSMAPIApi
|
|
16
|
+
from cosmotech.asset_data_layer_client.api.datasets_api import DatasetsApi
|
|
17
|
+
from cosmotech.asset_data_layer_client.api.runners_api import RunnersApi
|
|
18
|
+
from cosmotech.asset_data_layer_client.api.scenarios_api import ScenariosApi
|
|
19
|
+
from cosmotech.asset_data_layer_client.api.default_api import DefaultApi
|
|
20
|
+
|
|
21
|
+
else:
|
|
22
|
+
from importlib import import_module
|
|
23
|
+
|
|
24
|
+
_exports = {
|
|
25
|
+
"CSMAPIApi": ".csmapi_api",
|
|
26
|
+
"DatasetsApi": ".datasets_api",
|
|
27
|
+
"RunnersApi": ".runners_api",
|
|
28
|
+
"ScenariosApi": ".scenarios_api",
|
|
29
|
+
"DefaultApi": ".default_api",
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
def __getattr__(name: str) -> object:
|
|
33
|
+
if (module_name := _exports.get(name)) is None:
|
|
34
|
+
raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
|
|
35
|
+
value = getattr(import_module(module_name, __name__), name)
|
|
36
|
+
globals()[name] = value
|
|
37
|
+
return value
|
|
38
|
+
|
|
39
|
+
def __dir__() -> list[str]:
|
|
40
|
+
return sorted(globals().keys() | _exports.keys())
|