Skip to content

Commit

Permalink
Minor update
Browse files Browse the repository at this point in the history
  • Loading branch information
emmanuelmathot committed Apr 4, 2024
1 parent 48fba64 commit a05a16d
Show file tree
Hide file tree
Showing 20 changed files with 879 additions and 93 deletions.
21 changes: 3 additions & 18 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ docs/PublicationRequest.md
docs/PublicationStatus.md
docs/RequestStatus.md
docs/RequestStatusCode.md
docs/ResourceDeletionTask.md
docs/ResourceStatusCode.md
docs/ResourceType.md
docs/ServicesApi.md
Expand Down Expand Up @@ -90,6 +91,7 @@ openapi_client/models/publication_request.py
openapi_client/models/publication_status.py
openapi_client/models/request_status.py
openapi_client/models/request_status_code.py
openapi_client/models/resource_deletion_task.py
openapi_client/models/resource_status_code.py
openapi_client/models/resource_type.py
openapi_client/models/share_folder_request.py
Expand All @@ -105,22 +107,5 @@ setup.cfg
setup.py
test-requirements.txt
test/__init__.py
test/test_background_job_request_status.py
test/test_catalog_publication_request.py
test/test_content_disposition.py
test/test_content_type.py
test/test_get_catalogue_by_id401_response.py
test/test_i_inventory_catalog.py
test/test_i_inventory_point.py
test/test_i_inventory_sts.py
test/test_i_publication_request.py
test/test_i_subject.py
test/test_import_status.py
test/test_inventory_api.py
test/test_inventory_type.py
test/test_publication_request.py
test/test_publication_status.py
test/test_resource_type.py
test/test_sts_inventory.py
test/test_sts_storage.py
test/test_resource_deletion_task.py
tox.ini
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,9 @@ Class | Method | HTTP request | Description
*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* | [**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_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
Expand Down Expand Up @@ -147,6 +149,7 @@ Class | Method | HTTP request | Description
- [PublicationStatus](docs/PublicationStatus.md)
- [RequestStatus](docs/RequestStatus.md)
- [RequestStatusCode](docs/RequestStatusCode.md)
- [ResourceDeletionTask](docs/ResourceDeletionTask.md)
- [ResourceStatusCode](docs/ResourceStatusCode.md)
- [ResourceType](docs/ResourceType.md)
- [ShareFolderRequest](docs/ShareFolderRequest.md)
Expand Down
1 change: 0 additions & 1 deletion docs/BackgroundJobRequestStatus.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**identifier** | **str** | | [optional] [readonly]
**status** | [**RequestStatusCode**](RequestStatusCode.md) | | [optional]
**links** | [**List[Link]**](Link.md) | | [optional] [readonly]

Expand Down
1 change: 0 additions & 1 deletion docs/ImportStatus.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**request** | [**ImportRequest**](ImportRequest.md) | | [optional]
**identifier** | **str** | | [optional] [readonly]
**status** | [**RequestStatusCode**](RequestStatusCode.md) | | [optional]
**links** | [**List[Link]**](Link.md) | | [optional] [readonly]

Expand Down
6 changes: 2 additions & 4 deletions docs/InventoryApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -304,7 +304,7 @@ This endpoint does not need any parameter.
[[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)

# **v2_inventory_catalogues_publish_post**
> PublicationRequest v2_inventory_catalogues_publish_post(catalog_id=catalog_id, catalog_publication_request=catalog_publication_request)
> PublicationRequest v2_inventory_catalogues_publish_post(catalog_publication_request=catalog_publication_request)
Submit a catalog publication request

Expand Down Expand Up @@ -338,12 +338,11 @@ configuration.access_token = os.environ["ACCESS_TOKEN"]
with openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = openapi_client.InventoryApi(api_client)
catalog_id = 'catalog_id_example' # str | (optional)
catalog_publication_request = openapi_client.CatalogPublicationRequest() # CatalogPublicationRequest | (optional)

try:
# Submit a catalog publication request
api_response = api_instance.v2_inventory_catalogues_publish_post(catalog_id=catalog_id, catalog_publication_request=catalog_publication_request)
api_response = api_instance.v2_inventory_catalogues_publish_post(catalog_publication_request=catalog_publication_request)
print("The response of InventoryApi->v2_inventory_catalogues_publish_post:\n")
pprint(api_response)
except Exception as e:
Expand All @@ -357,7 +356,6 @@ with openapi_client.ApiClient(configuration) as api_client:

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**catalog_id** | **str**| | [optional]
**catalog_publication_request** | [**CatalogPublicationRequest**](CatalogPublicationRequest.md)| | [optional]

### Return type
Expand Down
1 change: 0 additions & 1 deletion docs/PublicationStatus.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**request** | [**IPublicationRequest**](IPublicationRequest.md) | | [optional]
**identifier** | **str** | | [optional] [readonly]
**status** | [**RequestStatusCode**](RequestStatusCode.md) | | [optional]
**links** | [**List[Link]**](Link.md) | | [optional] [readonly]

Expand Down
30 changes: 30 additions & 0 deletions docs/ResourceDeletionTask.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# ResourceDeletionTask


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | |
**background_job_id** | **str** | |

## Example

```python
from openapi_client.models.resource_deletion_task import ResourceDeletionTask

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

# convert the object into a dict
resource_deletion_task_dict = resource_deletion_task_instance.to_dict()
# create an instance of ResourceDeletionTask from a dict
resource_deletion_task_form_dict = resource_deletion_task.from_dict(resource_deletion_task_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)


1 change: 1 addition & 0 deletions docs/ShareFolderRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**path** | **str** | | [optional]
**users** | **List[str]** | | [optional]
**groups** | **List[str]** | | [optional]

## Example

Expand Down
161 changes: 156 additions & 5 deletions docs/StorageApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ All URIs are relative to *https://api.bios-dev.terradue.com/core*
Method | HTTP request | Description
------------- | ------------- | -------------
[**claim_workspace**](StorageApi.md#claim_workspace) | **POST** /v2/storage/workspaces/{workspaceId}/claim | Claim a workspace
[**delete_shared_folder_by_id**](StorageApi.md#delete_shared_folder_by_id) | **DELETE** /v2/storage/sharedfolders/{sharedFolderId} |
[**get_shared_folder_by_id**](StorageApi.md#get_shared_folder_by_id) | **GET** /v2/storage/sharedfolders/{sharedFolderId} | Get the shared folder information for a specific id
[**get_shared_folders**](StorageApi.md#get_shared_folders) | **GET** /v2/storage/sharedfolders | Get all the workspaces information related to an authenticated user
[**get_workspace_by_id**](StorageApi.md#get_workspace_by_id) | **GET** /v2/storage/workspaces/{workspaceId} | Get the workspace information for a specific id
[**get_workspace_import_status**](StorageApi.md#get_workspace_import_status) | **GET** /v2/storage/workspaces/imports/{importId} | Get Status of an import
[**get_workspaces**](StorageApi.md#get_workspaces) | **GET** /v2/storage/workspaces | Get all the workspaces information related to an authenticated user
Expand Down Expand Up @@ -91,8 +93,83 @@ 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)

# **delete_shared_folder_by_id**
> ResourceDeletionTask delete_shared_folder_by_id(shared_folder_id)


### Example

* OAuth Authentication (AccessToken):

```python
import openapi_client
from openapi_client.models.resource_deletion_task import ResourceDeletionTask
from openapi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.bios-dev.terradue.com/core
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
host = "https://api.bios-dev.terradue.com/core"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = openapi_client.StorageApi(api_client)
shared_folder_id = 'shared_folder_id_example' # str |

try:
api_response = api_instance.delete_shared_folder_by_id(shared_folder_id)
print("The response of StorageApi->delete_shared_folder_by_id:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling StorageApi->delete_shared_folder_by_id: %s\n" % e)
```



### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**shared_folder_id** | **str**| |

### Return type

[**ResourceDeletionTask**](ResourceDeletionTask.md)

### Authorization

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

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**202** | Shared Folder deletion task | - |
**401** | Unauthorized | - |
**404** | Shared Folder not found | - |
**403** | Forbidden | - |

[[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_shared_folder_by_id**
> get_shared_folder_by_id(shared_folder_id)
> ISharedFolder get_shared_folder_by_id(shared_folder_id)
Get the shared folder information for a specific id

Expand All @@ -102,6 +179,7 @@ Get the shared folder information for a specific id

```python
import openapi_client
from openapi_client.models.i_shared_folder import ISharedFolder
from openapi_client.rest import ApiException
from pprint import pprint

Expand All @@ -126,7 +204,9 @@ with openapi_client.ApiClient(configuration) as api_client:

try:
# Get the shared folder information for a specific id
api_instance.get_shared_folder_by_id(shared_folder_id)
api_response = api_instance.get_shared_folder_by_id(shared_folder_id)
print("The response of StorageApi->get_shared_folder_by_id:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling StorageApi->get_shared_folder_by_id: %s\n" % e)
```
Expand All @@ -142,7 +222,7 @@ Name | Type | Description | Notes

### Return type

void (empty response body)
[**ISharedFolder**](ISharedFolder.md)

### Authorization

Expand All @@ -157,9 +237,80 @@ void (empty response body)

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Success | - |
**200** | Shared Folder | - |
**401** | Unauthorized | - |
**404** | Shared Folder not found | - |
**403** | Forbidden | - |

[[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_shared_folders**
> List[ISharedFolder] get_shared_folders()
Get all the workspaces information related to an authenticated user

### Example

* OAuth Authentication (AccessToken):

```python
import openapi_client
from openapi_client.models.i_shared_folder import ISharedFolder
from openapi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.bios-dev.terradue.com/core
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
host = "https://api.bios-dev.terradue.com/core"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = openapi_client.StorageApi(api_client)

try:
# Get all the workspaces information related to an authenticated user
api_response = api_instance.get_shared_folders()
print("The response of StorageApi->get_shared_folders:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling StorageApi->get_shared_folders: %s\n" % e)
```



### Parameters

This endpoint does not need any parameter.

### Return type

[**List[ISharedFolder]**](ISharedFolder.md)

### Authorization

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

### HTTP request headers

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

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | List of shared folders | - |
**401** | Unauthorized | - |
**404** | Not Found | - |
**403** | Forbidden | - |

[[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)
Expand Down
1 change: 1 addition & 0 deletions openapi_client/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@
from openapi_client.models.publication_status import PublicationStatus
from openapi_client.models.request_status import RequestStatus
from openapi_client.models.request_status_code import RequestStatusCode
from openapi_client.models.resource_deletion_task import ResourceDeletionTask
from openapi_client.models.resource_status_code import ResourceStatusCode
from openapi_client.models.resource_type import ResourceType
from openapi_client.models.share_folder_request import ShareFolderRequest
Expand Down
Loading

0 comments on commit a05a16d

Please sign in to comment.