Skip to content

Commit

Permalink
Update API response types in user_api.py and control_api.py
Browse files Browse the repository at this point in the history
  • Loading branch information
emmanuelmathot committed Apr 8, 2024
1 parent 3646789 commit 9b45b2c
Show file tree
Hide file tree
Showing 20 changed files with 1,285 additions and 754 deletions.
7 changes: 5 additions & 2 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ docs/ContentType.md
docs/ControlApi.md
docs/DataCastingEnum.md
docs/DataCastingRequest.md
docs/GetCatalogueById401Response.md
docs/GetJobStatus401Response.md
docs/HttpValidationProblemDetails.md
docs/IInventoryCatalog.md
docs/IInventoryPoint.md
Expand All @@ -24,6 +24,7 @@ docs/ISharedFolder.md
docs/IStoragePoint.md
docs/IStorageSTS.md
docs/ISubject.md
docs/ITranslator.md
docs/IWorkspace.md
docs/ImportRequest.md
docs/ImportStatus.md
Expand Down Expand Up @@ -69,7 +70,7 @@ openapi_client/models/content_disposition.py
openapi_client/models/content_type.py
openapi_client/models/data_casting_enum.py
openapi_client/models/data_casting_request.py
openapi_client/models/get_catalogue_by_id401_response.py
openapi_client/models/get_job_status401_response.py
openapi_client/models/http_validation_problem_details.py
openapi_client/models/i_inventory_catalog.py
openapi_client/models/i_inventory_point.py
Expand All @@ -80,6 +81,7 @@ openapi_client/models/i_shared_folder.py
openapi_client/models/i_storage_point.py
openapi_client/models/i_storage_sts.py
openapi_client/models/i_subject.py
openapi_client/models/i_translator.py
openapi_client/models/i_workspace.py
openapi_client/models/import_request.py
openapi_client/models/import_status.py
Expand Down Expand Up @@ -107,4 +109,5 @@ setup.cfg
setup.py
test-requirements.txt
test/__init__.py
test/test_i_translator.py
tox.ini
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,22 +96,23 @@ Class | Method | HTTP request | Description
*InventoryApi* | [**get_catalogue_by_id**](docs/InventoryApi.md#get_catalogue_by_id) | **GET** /v2/inventory/catalogues/{catalogueId} | Get the catalogue information for a specific id
*InventoryApi* | [**get_catalogue_publication_status**](docs/InventoryApi.md#get_catalogue_publication_status) | **GET** /v2/inventory/catalogues/publication/{publicationId} | Get Status of an import
*InventoryApi* | [**get_catalogues**](docs/InventoryApi.md#get_catalogues) | **GET** /v2/inventory/catalogues | Get all the catalogues information related to an authenticated user
*InventoryApi* | [**v2_inventory_catalogues_publish_post**](docs/InventoryApi.md#v2_inventory_catalogues_publish_post) | **POST** /v2/inventory/catalogues/publish | Submit a catalog publication request
*InventoryApi* | [**v2_inventory_token_get**](docs/InventoryApi.md#v2_inventory_token_get) | **GET** /v2/inventory/token | Get Credentials for specific inventory point (e.g catalog, collection)
*InventoryApi* | [**get_inventory_sts**](docs/InventoryApi.md#get_inventory_sts) | **GET** /v2/inventory/token | Get Credentials for specific inventory point (e.g catalog, collection)
*InventoryApi* | [**get_supported_formats**](docs/InventoryApi.md#get_supported_formats) | **GET** /v2/inventory/formats | Get the supported formats for the inventory point
*InventoryApi* | [**publish**](docs/InventoryApi.md#publish) | **POST** /v2/inventory/catalogues/publish | Submit a catalog publication request
*ServicesApi* | [**cast_time_series**](docs/ServicesApi.md#cast_time_series) | **POST** /v2/services/timeseries/cast | Request casting for a time series.
*ServicesApi* | [**get_data_casting_status_async**](docs/ServicesApi.md#get_data_casting_status_async) | **GET** /v2/services/datacast/casts/{castId} | Get the status of a casting request
*ServicesApi* | [**post_data_casting**](docs/ServicesApi.md#post_data_casting) | **POST** /v2/services/datacast/cast | Request casting for a generic data resource
*StorageApi* | [**claim_workspace**](docs/StorageApi.md#claim_workspace) | **POST** /v2/storage/workspaces/{workspaceId}/claim | Claim a workspace
*StorageApi* | [**delete_shared_folder_by_id**](docs/StorageApi.md#delete_shared_folder_by_id) | **DELETE** /v2/storage/sharedfolders/{sharedFolderId} |
*StorageApi* | [**download**](docs/StorageApi.md#download) | **POST** /v2/storage/download | Request a download URL for a given resource
*StorageApi* | [**get_shared_folder_by_id**](docs/StorageApi.md#get_shared_folder_by_id) | **GET** /v2/storage/sharedfolders/{sharedFolderId} | Get the shared folder information for a specific id
*StorageApi* | [**get_shared_folders**](docs/StorageApi.md#get_shared_folders) | **GET** /v2/storage/sharedfolders | Get all the workspaces information related to an authenticated user
*StorageApi* | [**get_storage_sts**](docs/StorageApi.md#get_storage_sts) | **GET** /v2/storage/token | Get Credentials for specific storage point (e.g workspace, shared folder...)
*StorageApi* | [**get_workspace_by_id**](docs/StorageApi.md#get_workspace_by_id) | **GET** /v2/storage/workspaces/{workspaceId} | Get the workspace information for a specific id
*StorageApi* | [**get_workspace_import_status**](docs/StorageApi.md#get_workspace_import_status) | **GET** /v2/storage/workspaces/imports/{importId} | Get Status of an import
*StorageApi* | [**get_workspaces**](docs/StorageApi.md#get_workspaces) | **GET** /v2/storage/workspaces | Get all the workspaces information related to an authenticated user
*StorageApi* | [**import_from_url**](docs/StorageApi.md#import_from_url) | **POST** /v2/storage/workspaces/{workspaceId}/import-catalog | Import resources from exisiting catalog
*StorageApi* | [**share_folder**](docs/StorageApi.md#share_folder) | **POST** /v2/storage/workspaces/{workspaceId}/share | Share a folder from a workspace with users
*StorageApi* | [**v2_storage_download_post**](docs/StorageApi.md#v2_storage_download_post) | **POST** /v2/storage/download | Request a download URL for a given resource
*StorageApi* | [**v2_storage_token_get**](docs/StorageApi.md#v2_storage_token_get) | **GET** /v2/storage/token | Get Credentials for specific storage point (e.g workspace, shared folder...)
*StorageApi* | [**v2_storage_workspaces_workspace_id_import_catalog_post**](docs/StorageApi.md#v2_storage_workspaces_workspace_id_import_catalog_post) | **POST** /v2/storage/workspaces/{workspaceId}/import-catalog | Import resources from exisiting catalog
*UserApi* | [**v2_user_info_get**](docs/UserApi.md#v2_user_info_get) | **GET** /v2/user/info | Get the principal user identities from the identity management system
*UserApi* | [**v2_user_platforms_get**](docs/UserApi.md#v2_user_platforms_get) | **GET** /v2/user/platforms | Get the principal user identities from the identity management system

Expand All @@ -127,7 +128,7 @@ Class | Method | HTTP request | Description
- [ContentType](docs/ContentType.md)
- [DataCastingEnum](docs/DataCastingEnum.md)
- [DataCastingRequest](docs/DataCastingRequest.md)
- [GetCatalogueById401Response](docs/GetCatalogueById401Response.md)
- [GetJobStatus401Response](docs/GetJobStatus401Response.md)
- [HttpValidationProblemDetails](docs/HttpValidationProblemDetails.md)
- [IInventoryCatalog](docs/IInventoryCatalog.md)
- [IInventoryPoint](docs/IInventoryPoint.md)
Expand All @@ -138,6 +139,7 @@ Class | Method | HTTP request | Description
- [IStoragePoint](docs/IStoragePoint.md)
- [IStorageSTS](docs/IStorageSTS.md)
- [ISubject](docs/ISubject.md)
- [ITranslator](docs/ITranslator.md)
- [IWorkspace](docs/IWorkspace.md)
- [ImportRequest](docs/ImportRequest.md)
- [ImportStatus](docs/ImportStatus.md)
Expand Down
13 changes: 7 additions & 6 deletions docs/CatalogPublicationRequest.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@
# CatalogPublicationRequest

Represents a request to publish metadata to a catalog.

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**url** | **str** | |
**catalog_id** | **str** | | [optional]
**additional_links** | [**List[Link]**](Link.md) | | [optional]
**subjects** | [**List[Subject]**](Subject.md) | | [optional]
**collection** | **str** | | [optional]
**depth** | **int** | | [optional]
**url** | **str** | Gets or sets the source URL of the metadata to publish. This source must point to a valid metadata document in a supported format. |
**catalog_id** | **str** | Gets or sets the catalog name where the metadata will be published. | [optional]
**additional_links** | [**List[Link]**](Link.md) | Gets or sets additional links to include in the metadata document. | [optional]
**subjects** | [**List[Subject]**](Subject.md) | Gets or sets the list of subjects to include in the metadata document. | [optional]
**collection** | **str** | Gets or sets the collection name where the metadata will be published. | [optional]
**depth** | **int** | Gets or sets the depth of the metadata to publish. 0 means no publication, 1 means the root metadata document only, 2 means the metadata document and its children, and so on. | [optional]

## Example

Expand Down
4 changes: 2 additions & 2 deletions docs/ControlApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,13 +70,13 @@ Name | Type | Description | Notes
### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Success | - |
**200** | The status of the job | - |
**401** | Unauthorized | - |
**403** | Forbidden | - |

Expand Down
2 changes: 1 addition & 1 deletion docs/GetJobStatus401Response.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ json = "{}"
# create an instance of GetJobStatus401Response from a JSON string
get_job_status401_response_instance = GetJobStatus401Response.from_json(json)
# print the JSON string representation of the object
print GetJobStatus401Response.to_json()
print(GetJobStatus401Response.to_json())

# convert the object into a dict
get_job_status401_response_dict = get_job_status401_response_instance.to_dict()
Expand Down
31 changes: 31 additions & 0 deletions docs/ITranslator.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# ITranslator


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**label** | **str** | | [optional] [readonly]
**priority** | **int** | | [optional]
**key** | **str** | | [optional]

## Example

```python
from openapi_client.models.i_translator import ITranslator

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

# convert the object into a dict
i_translator_dict = i_translator_instance.to_dict()
# create an instance of ITranslator from a dict
i_translator_form_dict = i_translator.from_dict(i_translator_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)


Loading

0 comments on commit 9b45b2c

Please sign in to comment.