From 2a9f31394ee5e31e71a5d0f1d9366fbaa379b701 Mon Sep 17 00:00:00 2001 From: Luis-Hebendanz Date: Mon, 8 Jan 2024 20:52:23 +0100 Subject: [PATCH] nix fmt --- .../tests/openapi_client/docs/DefaultApi.md | 68 ++--- .../tests/openapi_client/docs/EntitiesApi.md | 240 +++++++++--------- .../tests/openapi_client/docs/Entity.md | 23 +- .../tests/openapi_client/docs/EntityCreate.md | 19 +- .../docs/HTTPValidationError.md | 11 +- .../tests/openapi_client/docs/Machine.md | 13 +- .../openapi_client/docs/RepositoriesApi.md | 34 ++- .../tests/openapi_client/docs/Resolution.md | 21 +- .../openapi_client/docs/ResolutionApi.md | 34 ++- .../tests/openapi_client/docs/Service.md | 25 +- .../openapi_client/docs/ServiceCreate.md | 23 +- .../tests/openapi_client/docs/ServicesApi.md | 140 +++++----- .../tests/openapi_client/docs/Status.md | 7 +- .../openapi_client/docs/ValidationError.md | 15 +- .../docs/ValidationErrorLocInner.md | 9 +- 15 files changed, 332 insertions(+), 350 deletions(-) diff --git a/pkgs/clan-cli/tests/openapi_client/docs/DefaultApi.md b/pkgs/clan-cli/tests/openapi_client/docs/DefaultApi.md index 9a4a45c..aef64f7 100644 --- a/pkgs/clan-cli/tests/openapi_client/docs/DefaultApi.md +++ b/pkgs/clan-cli/tests/openapi_client/docs/DefaultApi.md @@ -1,15 +1,15 @@ # openapi_client.DefaultApi -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get**](DefaultApi.md#get) | **GET** /ws2_example | Get -[**health**](DefaultApi.md#health) | **GET** /health | Health -[**root**](DefaultApi.md#root) | **GET** /{path_name} | Root +All URIs are relative to _http://localhost_ +| Method | HTTP request | Description | +| ---------------------------------- | -------------------- | ----------- | +| [**get**](DefaultApi.md#get) | **GET** /ws2_example | Get | +| [**health**](DefaultApi.md#health) | **GET** /health | Health | +| [**root**](DefaultApi.md#root) | **GET** /{path_name} | Root | # **get** + > get() Get @@ -42,9 +42,8 @@ with openapi_client.ApiClient(configuration) as api_client: print("Exception when calling DefaultApi->get: %s\n" % e) ``` - - ### Parameters + This endpoint does not need any parameter. ### Return type @@ -57,17 +56,19 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json +- **Content-Type**: Not defined +- **Accept**: application/json ### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful Response | - | + +| Status code | Description | Response headers | +| ----------- | ------------------- | ---------------- | +| **200** | Successful Response | - | [[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) # **health** + > Machine health() Health @@ -103,9 +104,8 @@ with openapi_client.ApiClient(configuration) as api_client: print("Exception when calling DefaultApi->health: %s\n" % e) ``` - - ### Parameters + This endpoint does not need any parameter. ### Return type @@ -118,17 +118,19 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json +- **Content-Type**: Not defined +- **Accept**: application/json ### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful Response | - | + +| Status code | Description | Response headers | +| ----------- | ------------------- | ---------------- | +| **200** | Successful Response | - | [[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) # **root** + > root(path_name) Root @@ -153,7 +155,7 @@ configuration = openapi_client.Configuration( with openapi_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = openapi_client.DefaultApi(api_client) - path_name = 'path_name_example' # str | + path_name = 'path_name_example' # str | try: # Root @@ -162,13 +164,11 @@ with openapi_client.ApiClient(configuration) as api_client: print("Exception when calling DefaultApi->root: %s\n" % e) ``` - - ### Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **path_name** | **str**| | +| Name | Type | Description | Notes | +| ------------- | ------- | ----------- | ----- | +| **path_name** | **str** | | ### Return type @@ -180,14 +180,14 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json +- **Content-Type**: Not defined +- **Accept**: application/json ### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful Response | - | -**422** | Validation Error | - | + +| 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) - diff --git a/pkgs/clan-cli/tests/openapi_client/docs/EntitiesApi.md b/pkgs/clan-cli/tests/openapi_client/docs/EntitiesApi.md index 4a99b6c..dc621f8 100644 --- a/pkgs/clan-cli/tests/openapi_client/docs/EntitiesApi.md +++ b/pkgs/clan-cli/tests/openapi_client/docs/EntitiesApi.md @@ -1,21 +1,21 @@ # openapi_client.EntitiesApi -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**attach_entity**](EntitiesApi.md#attach_entity) | **POST** /api/v1/attach | Attach Entity -[**create_entity**](EntitiesApi.md#create_entity) | **POST** /api/v1/entity | Create Entity -[**delete_entity**](EntitiesApi.md#delete_entity) | **DELETE** /api/v1/entity | Delete Entity -[**detach_entity**](EntitiesApi.md#detach_entity) | **POST** /api/v1/detach | Detach Entity -[**get_all_entities**](EntitiesApi.md#get_all_entities) | **GET** /api/v1/entities | Get All Entities -[**get_attached_entities**](EntitiesApi.md#get_attached_entities) | **GET** /api/v1/attached_entities | Get Attached Entities -[**get_entity_by_did**](EntitiesApi.md#get_entity_by_did) | **GET** /api/v1/entity | Get Entity By Did -[**get_entity_by_name**](EntitiesApi.md#get_entity_by_name) | **GET** /api/v1/entity_by_name | Get Entity By Name -[**is_attached**](EntitiesApi.md#is_attached) | **GET** /api/v1/is_attached | Is Attached +All URIs are relative to _http://localhost_ +| Method | HTTP request | Description | +| ----------------------------------------------------------------- | --------------------------------- | --------------------- | +| [**attach_entity**](EntitiesApi.md#attach_entity) | **POST** /api/v1/attach | Attach Entity | +| [**create_entity**](EntitiesApi.md#create_entity) | **POST** /api/v1/entity | Create Entity | +| [**delete_entity**](EntitiesApi.md#delete_entity) | **DELETE** /api/v1/entity | Delete Entity | +| [**detach_entity**](EntitiesApi.md#detach_entity) | **POST** /api/v1/detach | Detach Entity | +| [**get_all_entities**](EntitiesApi.md#get_all_entities) | **GET** /api/v1/entities | Get All Entities | +| [**get_attached_entities**](EntitiesApi.md#get_attached_entities) | **GET** /api/v1/attached_entities | Get Attached Entities | +| [**get_entity_by_did**](EntitiesApi.md#get_entity_by_did) | **GET** /api/v1/entity | Get Entity By Did | +| [**get_entity_by_name**](EntitiesApi.md#get_entity_by_name) | **GET** /api/v1/entity_by_name | Get Entity By Name | +| [**is_attached**](EntitiesApi.md#is_attached) | **GET** /api/v1/is_attached | Is Attached | # **attach_entity** + > Dict[str, str] attach_entity(entity_did=entity_did, skip=skip, limit=limit) Attach Entity @@ -53,15 +53,13 @@ with openapi_client.ApiClient(configuration) as api_client: print("Exception when calling EntitiesApi->attach_entity: %s\n" % e) ``` - - ### Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **entity_did** | **str**| | [optional] [default to 'did:sov:test:1234'] - **skip** | **int**| | [optional] [default to 0] - **limit** | **int**| | [optional] [default to 100] +| Name | Type | Description | Notes | +| -------------- | ------- | ----------- | --------------------------------------------------- | +| **entity_did** | **str** | | [optional] [default to 'did:sov:test:1234'] | +| **skip** | **int** | | [optional] [default to 0] | +| **limit** | **int** | | [optional] [default to 100] | ### Return type @@ -73,18 +71,20 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json +- **Content-Type**: Not defined +- **Accept**: application/json ### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful Response | - | -**422** | Validation Error | - | + +| 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) # **create_entity** + > Entity create_entity(entity_create) Create Entity @@ -111,7 +111,7 @@ configuration = openapi_client.Configuration( with openapi_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = openapi_client.EntitiesApi(api_client) - entity_create = openapi_client.EntityCreate() # EntityCreate | + entity_create = openapi_client.EntityCreate() # EntityCreate | try: # Create Entity @@ -122,13 +122,11 @@ with openapi_client.ApiClient(configuration) as api_client: print("Exception when calling EntitiesApi->create_entity: %s\n" % e) ``` - - ### Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **entity_create** | [**EntityCreate**](EntityCreate.md)| | +| Name | Type | Description | Notes | +| ----------------- | ----------------------------------- | ----------- | ----- | +| **entity_create** | [**EntityCreate**](EntityCreate.md) | | ### Return type @@ -140,18 +138,20 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json ### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful Response | - | -**422** | Validation Error | - | + +| 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) # **delete_entity** + > Dict[str, str] delete_entity(entity_did=entity_did) Delete Entity @@ -187,13 +187,11 @@ with openapi_client.ApiClient(configuration) as api_client: print("Exception when calling EntitiesApi->delete_entity: %s\n" % e) ``` - - ### Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **entity_did** | **str**| | [optional] [default to 'did:sov:test:1234'] +| Name | Type | Description | Notes | +| -------------- | ------- | ----------- | --------------------------------------------------- | +| **entity_did** | **str** | | [optional] [default to 'did:sov:test:1234'] | ### Return type @@ -205,18 +203,20 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json +- **Content-Type**: Not defined +- **Accept**: application/json ### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful Response | - | -**422** | Validation Error | - | + +| 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) # **detach_entity** + > Dict[str, str] detach_entity(entity_did=entity_did, skip=skip, limit=limit) Detach Entity @@ -254,15 +254,13 @@ with openapi_client.ApiClient(configuration) as api_client: print("Exception when calling EntitiesApi->detach_entity: %s\n" % e) ``` - - ### Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **entity_did** | **str**| | [optional] [default to 'did:sov:test:1234'] - **skip** | **int**| | [optional] [default to 0] - **limit** | **int**| | [optional] [default to 100] +| Name | Type | Description | Notes | +| -------------- | ------- | ----------- | --------------------------------------------------- | +| **entity_did** | **str** | | [optional] [default to 'did:sov:test:1234'] | +| **skip** | **int** | | [optional] [default to 0] | +| **limit** | **int** | | [optional] [default to 100] | ### Return type @@ -274,18 +272,20 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json +- **Content-Type**: Not defined +- **Accept**: application/json ### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful Response | - | -**422** | Validation Error | - | + +| 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) # **get_all_entities** + > List[Entity] get_all_entities(skip=skip, limit=limit) Get All Entities @@ -323,14 +323,12 @@ with openapi_client.ApiClient(configuration) as api_client: print("Exception when calling EntitiesApi->get_all_entities: %s\n" % e) ``` - - ### Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **skip** | **int**| | [optional] [default to 0] - **limit** | **int**| | [optional] [default to 100] +| Name | Type | Description | Notes | +| --------- | ------- | ----------- | --------------------------- | +| **skip** | **int** | | [optional] [default to 0] | +| **limit** | **int** | | [optional] [default to 100] | ### Return type @@ -342,18 +340,20 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json +- **Content-Type**: Not defined +- **Accept**: application/json ### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful Response | - | -**422** | Validation Error | - | + +| 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) # **get_attached_entities** + > List[Entity] get_attached_entities(skip=skip, limit=limit) Get Attached Entities @@ -391,14 +391,12 @@ with openapi_client.ApiClient(configuration) as api_client: print("Exception when calling EntitiesApi->get_attached_entities: %s\n" % e) ``` - - ### Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **skip** | **int**| | [optional] [default to 0] - **limit** | **int**| | [optional] [default to 100] +| Name | Type | Description | Notes | +| --------- | ------- | ----------- | --------------------------- | +| **skip** | **int** | | [optional] [default to 0] | +| **limit** | **int** | | [optional] [default to 100] | ### Return type @@ -410,18 +408,20 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json +- **Content-Type**: Not defined +- **Accept**: application/json ### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful Response | - | -**422** | Validation Error | - | + +| 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) # **get_entity_by_did** + > Entity get_entity_by_did(entity_did=entity_did) Get Entity By Did @@ -458,13 +458,11 @@ with openapi_client.ApiClient(configuration) as api_client: print("Exception when calling EntitiesApi->get_entity_by_did: %s\n" % e) ``` - - ### Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **entity_did** | **str**| | [optional] [default to 'did:sov:test:1234'] +| Name | Type | Description | Notes | +| -------------- | ------- | ----------- | --------------------------------------------------- | +| **entity_did** | **str** | | [optional] [default to 'did:sov:test:1234'] | ### Return type @@ -476,18 +474,20 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json +- **Content-Type**: Not defined +- **Accept**: application/json ### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful Response | - | -**422** | Validation Error | - | + +| 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) # **get_entity_by_name** + > Entity get_entity_by_name(entity_name) Get Entity By Name @@ -513,7 +513,7 @@ configuration = openapi_client.Configuration( with openapi_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = openapi_client.EntitiesApi(api_client) - entity_name = 'entity_name_example' # str | + entity_name = 'entity_name_example' # str | try: # Get Entity By Name @@ -524,13 +524,11 @@ with openapi_client.ApiClient(configuration) as api_client: print("Exception when calling EntitiesApi->get_entity_by_name: %s\n" % e) ``` - - ### Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **entity_name** | **str**| | +| Name | Type | Description | Notes | +| --------------- | ------- | ----------- | ----- | +| **entity_name** | **str** | | ### Return type @@ -542,18 +540,20 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json +- **Content-Type**: Not defined +- **Accept**: application/json ### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful Response | - | -**422** | Validation Error | - | + +| 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) # **is_attached** + > Dict[str, str] is_attached(entity_did=entity_did) Is Attached @@ -589,13 +589,11 @@ with openapi_client.ApiClient(configuration) as api_client: print("Exception when calling EntitiesApi->is_attached: %s\n" % e) ``` - - ### Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **entity_did** | **str**| | [optional] [default to 'did:sov:test:1234'] +| Name | Type | Description | Notes | +| -------------- | ------- | ----------- | --------------------------------------------------- | +| **entity_did** | **str** | | [optional] [default to 'did:sov:test:1234'] | ### Return type @@ -607,14 +605,14 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json +- **Content-Type**: Not defined +- **Accept**: application/json ### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful Response | - | -**422** | Validation Error | - | + +| 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) - diff --git a/pkgs/clan-cli/tests/openapi_client/docs/Entity.md b/pkgs/clan-cli/tests/openapi_client/docs/Entity.md index ed3b3be..fa7efb2 100644 --- a/pkgs/clan-cli/tests/openapi_client/docs/Entity.md +++ b/pkgs/clan-cli/tests/openapi_client/docs/Entity.md @@ -1,16 +1,16 @@ # Entity - ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**did** | **str** | | -**name** | **str** | | -**ip** | **str** | | -**visible** | **bool** | | -**other** | **object** | | -**attached** | **bool** | | -**stop_health_task** | **bool** | | + +| Name | Type | Description | Notes | +| -------------------- | ---------- | ----------- | ----- | +| **did** | **str** | | +| **name** | **str** | | +| **ip** | **str** | | +| **visible** | **bool** | | +| **other** | **object** | | +| **attached** | **bool** | | +| **stop_health_task** | **bool** | | ## Example @@ -29,6 +29,5 @@ entity_dict = entity_instance.to_dict() # create an instance of Entity from a dict entity_form_dict = entity.from_dict(entity_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) - - diff --git a/pkgs/clan-cli/tests/openapi_client/docs/EntityCreate.md b/pkgs/clan-cli/tests/openapi_client/docs/EntityCreate.md index 7cd1831..4fff16a 100644 --- a/pkgs/clan-cli/tests/openapi_client/docs/EntityCreate.md +++ b/pkgs/clan-cli/tests/openapi_client/docs/EntityCreate.md @@ -1,14 +1,14 @@ # EntityCreate - ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**did** | **str** | | -**name** | **str** | | -**ip** | **str** | | -**visible** | **bool** | | -**other** | **object** | | + +| Name | Type | Description | Notes | +| ----------- | ---------- | ----------- | ----- | +| **did** | **str** | | +| **name** | **str** | | +| **ip** | **str** | | +| **visible** | **bool** | | +| **other** | **object** | | ## Example @@ -27,6 +27,5 @@ entity_create_dict = entity_create_instance.to_dict() # create an instance of EntityCreate from a dict entity_create_form_dict = entity_create.from_dict(entity_create_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) - - diff --git a/pkgs/clan-cli/tests/openapi_client/docs/HTTPValidationError.md b/pkgs/clan-cli/tests/openapi_client/docs/HTTPValidationError.md index 5eee49b..d4902e7 100644 --- a/pkgs/clan-cli/tests/openapi_client/docs/HTTPValidationError.md +++ b/pkgs/clan-cli/tests/openapi_client/docs/HTTPValidationError.md @@ -1,10 +1,10 @@ # HTTPValidationError - ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**detail** | [**List[ValidationError]**](ValidationError.md) | | [optional] + +| Name | Type | Description | Notes | +| ---------- | ----------------------------------------------- | ----------- | ---------- | +| **detail** | [**List[ValidationError]**](ValidationError.md) | | [optional] | ## Example @@ -23,6 +23,5 @@ http_validation_error_dict = http_validation_error_instance.to_dict() # create an instance of HTTPValidationError from a dict http_validation_error_form_dict = http_validation_error.from_dict(http_validation_error_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) - - diff --git a/pkgs/clan-cli/tests/openapi_client/docs/Machine.md b/pkgs/clan-cli/tests/openapi_client/docs/Machine.md index 4ea6dc3..062fd51 100644 --- a/pkgs/clan-cli/tests/openapi_client/docs/Machine.md +++ b/pkgs/clan-cli/tests/openapi_client/docs/Machine.md @@ -1,11 +1,11 @@ # Machine - ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | | -**status** | [**Status**](Status.md) | | + +| Name | Type | Description | Notes | +| ---------- | ----------------------- | ----------- | ----- | +| **name** | **str** | | +| **status** | [**Status**](Status.md) | | ## Example @@ -24,6 +24,5 @@ machine_dict = machine_instance.to_dict() # create an instance of Machine from a dict machine_form_dict = machine.from_dict(machine_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) - - diff --git a/pkgs/clan-cli/tests/openapi_client/docs/RepositoriesApi.md b/pkgs/clan-cli/tests/openapi_client/docs/RepositoriesApi.md index 7a24ab0..ff735f0 100644 --- a/pkgs/clan-cli/tests/openapi_client/docs/RepositoriesApi.md +++ b/pkgs/clan-cli/tests/openapi_client/docs/RepositoriesApi.md @@ -1,13 +1,13 @@ # openapi_client.RepositoriesApi -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_all_repositories**](RepositoriesApi.md#get_all_repositories) | **GET** /api/v1/repositories | Get All Repositories +All URIs are relative to _http://localhost_ +| Method | HTTP request | Description | +| ------------------------------------------------------------------- | ---------------------------- | -------------------- | +| [**get_all_repositories**](RepositoriesApi.md#get_all_repositories) | **GET** /api/v1/repositories | Get All Repositories | # **get_all_repositories** + > List[Service] get_all_repositories(skip=skip, limit=limit) Get All Repositories @@ -45,14 +45,12 @@ with openapi_client.ApiClient(configuration) as api_client: print("Exception when calling RepositoriesApi->get_all_repositories: %s\n" % e) ``` - - ### Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **skip** | **int**| | [optional] [default to 0] - **limit** | **int**| | [optional] [default to 100] +| Name | Type | Description | Notes | +| --------- | ------- | ----------- | --------------------------- | +| **skip** | **int** | | [optional] [default to 0] | +| **limit** | **int** | | [optional] [default to 100] | ### Return type @@ -64,14 +62,14 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json +- **Content-Type**: Not defined +- **Accept**: application/json ### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful Response | - | -**422** | Validation Error | - | + +| 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) - diff --git a/pkgs/clan-cli/tests/openapi_client/docs/Resolution.md b/pkgs/clan-cli/tests/openapi_client/docs/Resolution.md index 27a3992..27928d5 100644 --- a/pkgs/clan-cli/tests/openapi_client/docs/Resolution.md +++ b/pkgs/clan-cli/tests/openapi_client/docs/Resolution.md @@ -1,15 +1,15 @@ # Resolution - ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**requester_name** | **str** | | -**requester_did** | **str** | | -**resolved_did** | **str** | | -**other** | **object** | | -**timestamp** | **datetime** | | -**id** | **int** | | + +| Name | Type | Description | Notes | +| ------------------ | ------------ | ----------- | ----- | +| **requester_name** | **str** | | +| **requester_did** | **str** | | +| **resolved_did** | **str** | | +| **other** | **object** | | +| **timestamp** | **datetime** | | +| **id** | **int** | | ## Example @@ -28,6 +28,5 @@ resolution_dict = resolution_instance.to_dict() # create an instance of Resolution from a dict resolution_form_dict = resolution.from_dict(resolution_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) - - diff --git a/pkgs/clan-cli/tests/openapi_client/docs/ResolutionApi.md b/pkgs/clan-cli/tests/openapi_client/docs/ResolutionApi.md index a2ae852..24da5fb 100644 --- a/pkgs/clan-cli/tests/openapi_client/docs/ResolutionApi.md +++ b/pkgs/clan-cli/tests/openapi_client/docs/ResolutionApi.md @@ -1,13 +1,13 @@ # openapi_client.ResolutionApi -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_all_resolutions**](ResolutionApi.md#get_all_resolutions) | **GET** /api/v1/resolutions | Get All Resolutions +All URIs are relative to _http://localhost_ +| Method | HTTP request | Description | +| --------------------------------------------------------------- | --------------------------- | ------------------- | +| [**get_all_resolutions**](ResolutionApi.md#get_all_resolutions) | **GET** /api/v1/resolutions | Get All Resolutions | # **get_all_resolutions** + > List[Resolution] get_all_resolutions(skip=skip, limit=limit) Get All Resolutions @@ -45,14 +45,12 @@ with openapi_client.ApiClient(configuration) as api_client: print("Exception when calling ResolutionApi->get_all_resolutions: %s\n" % e) ``` - - ### Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **skip** | **int**| | [optional] [default to 0] - **limit** | **int**| | [optional] [default to 100] +| Name | Type | Description | Notes | +| --------- | ------- | ----------- | --------------------------- | +| **skip** | **int** | | [optional] [default to 0] | +| **limit** | **int** | | [optional] [default to 100] | ### Return type @@ -64,14 +62,14 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json +- **Content-Type**: Not defined +- **Accept**: application/json ### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful Response | - | -**422** | Validation Error | - | + +| 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) - diff --git a/pkgs/clan-cli/tests/openapi_client/docs/Service.md b/pkgs/clan-cli/tests/openapi_client/docs/Service.md index bff9e15..5798f74 100644 --- a/pkgs/clan-cli/tests/openapi_client/docs/Service.md +++ b/pkgs/clan-cli/tests/openapi_client/docs/Service.md @@ -1,17 +1,17 @@ # Service - ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**uuid** | **str** | | -**service_name** | **str** | | -**service_type** | **str** | | -**endpoint_url** | **str** | | -**status** | **str** | | -**other** | **object** | | -**entity_did** | **str** | | -**entity** | [**Entity**](Entity.md) | | + +| Name | Type | Description | Notes | +| ---------------- | ----------------------- | ----------- | ----- | +| **uuid** | **str** | | +| **service_name** | **str** | | +| **service_type** | **str** | | +| **endpoint_url** | **str** | | +| **status** | **str** | | +| **other** | **object** | | +| **entity_did** | **str** | | +| **entity** | [**Entity**](Entity.md) | | ## Example @@ -30,6 +30,5 @@ service_dict = service_instance.to_dict() # create an instance of Service from a dict service_form_dict = service.from_dict(service_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) - - diff --git a/pkgs/clan-cli/tests/openapi_client/docs/ServiceCreate.md b/pkgs/clan-cli/tests/openapi_client/docs/ServiceCreate.md index f8e84e1..7843b1a 100644 --- a/pkgs/clan-cli/tests/openapi_client/docs/ServiceCreate.md +++ b/pkgs/clan-cli/tests/openapi_client/docs/ServiceCreate.md @@ -1,16 +1,16 @@ # ServiceCreate - ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**uuid** | **str** | | -**service_name** | **str** | | -**service_type** | **str** | | -**endpoint_url** | **str** | | -**status** | **str** | | -**other** | **object** | | -**entity_did** | **str** | | + +| Name | Type | Description | Notes | +| ---------------- | ---------- | ----------- | ----- | +| **uuid** | **str** | | +| **service_name** | **str** | | +| **service_type** | **str** | | +| **endpoint_url** | **str** | | +| **status** | **str** | | +| **other** | **object** | | +| **entity_did** | **str** | | ## Example @@ -29,6 +29,5 @@ service_create_dict = service_create_instance.to_dict() # create an instance of ServiceCreate from a dict service_create_form_dict = service_create.from_dict(service_create_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) - - diff --git a/pkgs/clan-cli/tests/openapi_client/docs/ServicesApi.md b/pkgs/clan-cli/tests/openapi_client/docs/ServicesApi.md index 9a2c544..006615a 100644 --- a/pkgs/clan-cli/tests/openapi_client/docs/ServicesApi.md +++ b/pkgs/clan-cli/tests/openapi_client/docs/ServicesApi.md @@ -1,17 +1,17 @@ # openapi_client.ServicesApi -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_service**](ServicesApi.md#create_service) | **POST** /api/v1/service | Create Service -[**delete_service**](ServicesApi.md#delete_service) | **DELETE** /api/v1/service | Delete Service -[**get_all_services**](ServicesApi.md#get_all_services) | **GET** /api/v1/services | Get All Services -[**get_service_by_did**](ServicesApi.md#get_service_by_did) | **GET** /api/v1/service | Get Service By Did -[**get_services_without_entity**](ServicesApi.md#get_services_without_entity) | **GET** /api/v1/services_without_entity | Get Services Without Entity +All URIs are relative to _http://localhost_ +| Method | HTTP request | Description | +| ----------------------------------------------------------------------------- | --------------------------------------- | --------------------------- | +| [**create_service**](ServicesApi.md#create_service) | **POST** /api/v1/service | Create Service | +| [**delete_service**](ServicesApi.md#delete_service) | **DELETE** /api/v1/service | Delete Service | +| [**get_all_services**](ServicesApi.md#get_all_services) | **GET** /api/v1/services | Get All Services | +| [**get_service_by_did**](ServicesApi.md#get_service_by_did) | **GET** /api/v1/service | Get Service By Did | +| [**get_services_without_entity**](ServicesApi.md#get_services_without_entity) | **GET** /api/v1/services_without_entity | Get Services Without Entity | # **create_service** + > Service create_service(service_create) Create Service @@ -38,7 +38,7 @@ configuration = openapi_client.Configuration( with openapi_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = openapi_client.ServicesApi(api_client) - service_create = openapi_client.ServiceCreate() # ServiceCreate | + service_create = openapi_client.ServiceCreate() # ServiceCreate | try: # Create Service @@ -49,13 +49,11 @@ with openapi_client.ApiClient(configuration) as api_client: print("Exception when calling ServicesApi->create_service: %s\n" % e) ``` - - ### Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **service_create** | [**ServiceCreate**](ServiceCreate.md)| | +| Name | Type | Description | Notes | +| ------------------ | ------------------------------------- | ----------- | ----- | +| **service_create** | [**ServiceCreate**](ServiceCreate.md) | | ### Return type @@ -67,18 +65,20 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json ### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful Response | - | -**422** | Validation Error | - | + +| 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) # **delete_service** + > Dict[str, str] delete_service(entity_did=entity_did) Delete Service @@ -114,13 +114,11 @@ with openapi_client.ApiClient(configuration) as api_client: print("Exception when calling ServicesApi->delete_service: %s\n" % e) ``` - - ### Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **entity_did** | **str**| | [optional] [default to 'did:sov:test:1234'] +| Name | Type | Description | Notes | +| -------------- | ------- | ----------- | --------------------------------------------------- | +| **entity_did** | **str** | | [optional] [default to 'did:sov:test:1234'] | ### Return type @@ -132,18 +130,20 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json +- **Content-Type**: Not defined +- **Accept**: application/json ### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful Response | - | -**422** | Validation Error | - | + +| 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) # **get_all_services** + > List[Service] get_all_services(skip=skip, limit=limit) Get All Services @@ -181,14 +181,12 @@ with openapi_client.ApiClient(configuration) as api_client: print("Exception when calling ServicesApi->get_all_services: %s\n" % e) ``` - - ### Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **skip** | **int**| | [optional] [default to 0] - **limit** | **int**| | [optional] [default to 100] +| Name | Type | Description | Notes | +| --------- | ------- | ----------- | --------------------------- | +| **skip** | **int** | | [optional] [default to 0] | +| **limit** | **int** | | [optional] [default to 100] | ### Return type @@ -200,18 +198,20 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json +- **Content-Type**: Not defined +- **Accept**: application/json ### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful Response | - | -**422** | Validation Error | - | + +| 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) # **get_service_by_did** + > List[Service] get_service_by_did(entity_did=entity_did, skip=skip, limit=limit) Get Service By Did @@ -250,15 +250,13 @@ with openapi_client.ApiClient(configuration) as api_client: print("Exception when calling ServicesApi->get_service_by_did: %s\n" % e) ``` - - ### Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **entity_did** | **str**| | [optional] [default to 'did:sov:test:1234'] - **skip** | **int**| | [optional] [default to 0] - **limit** | **int**| | [optional] [default to 100] +| Name | Type | Description | Notes | +| -------------- | ------- | ----------- | --------------------------------------------------- | +| **entity_did** | **str** | | [optional] [default to 'did:sov:test:1234'] | +| **skip** | **int** | | [optional] [default to 0] | +| **limit** | **int** | | [optional] [default to 100] | ### Return type @@ -270,18 +268,20 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json +- **Content-Type**: Not defined +- **Accept**: application/json ### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful Response | - | -**422** | Validation Error | - | + +| 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) # **get_services_without_entity** + > List[Service] get_services_without_entity(entity_did=entity_did, skip=skip, limit=limit) Get Services Without Entity @@ -320,15 +320,13 @@ with openapi_client.ApiClient(configuration) as api_client: print("Exception when calling ServicesApi->get_services_without_entity: %s\n" % e) ``` - - ### Parameters -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **entity_did** | **str**| | [optional] [default to 'did:sov:test:1234'] - **skip** | **int**| | [optional] [default to 0] - **limit** | **int**| | [optional] [default to 100] +| Name | Type | Description | Notes | +| -------------- | ------- | ----------- | --------------------------------------------------- | +| **entity_did** | **str** | | [optional] [default to 'did:sov:test:1234'] | +| **skip** | **int** | | [optional] [default to 0] | +| **limit** | **int** | | [optional] [default to 100] | ### Return type @@ -340,14 +338,14 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json +- **Content-Type**: Not defined +- **Accept**: application/json ### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successful Response | - | -**422** | Validation Error | - | + +| 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) - diff --git a/pkgs/clan-cli/tests/openapi_client/docs/Status.md b/pkgs/clan-cli/tests/openapi_client/docs/Status.md index 3b89cf4..10bd223 100644 --- a/pkgs/clan-cli/tests/openapi_client/docs/Status.md +++ b/pkgs/clan-cli/tests/openapi_client/docs/Status.md @@ -3,9 +3,8 @@ An enumeration. ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/pkgs/clan-cli/tests/openapi_client/docs/ValidationError.md b/pkgs/clan-cli/tests/openapi_client/docs/ValidationError.md index 04310f6..b57b565 100644 --- a/pkgs/clan-cli/tests/openapi_client/docs/ValidationError.md +++ b/pkgs/clan-cli/tests/openapi_client/docs/ValidationError.md @@ -1,12 +1,12 @@ # ValidationError - ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**loc** | [**List[ValidationErrorLocInner]**](ValidationErrorLocInner.md) | | -**msg** | **str** | | -**type** | **str** | | + +| Name | Type | Description | Notes | +| -------- | --------------------------------------------------------------- | ----------- | ----- | +| **loc** | [**List[ValidationErrorLocInner]**](ValidationErrorLocInner.md) | | +| **msg** | **str** | | +| **type** | **str** | | ## Example @@ -25,6 +25,5 @@ validation_error_dict = validation_error_instance.to_dict() # create an instance of ValidationError from a dict validation_error_form_dict = validation_error.from_dict(validation_error_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) - - diff --git a/pkgs/clan-cli/tests/openapi_client/docs/ValidationErrorLocInner.md b/pkgs/clan-cli/tests/openapi_client/docs/ValidationErrorLocInner.md index 0bae52d..04e49df 100644 --- a/pkgs/clan-cli/tests/openapi_client/docs/ValidationErrorLocInner.md +++ b/pkgs/clan-cli/tests/openapi_client/docs/ValidationErrorLocInner.md @@ -1,9 +1,9 @@ # ValidationErrorLocInner - ## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | ## Example @@ -22,6 +22,5 @@ validation_error_loc_inner_dict = validation_error_loc_inner_instance.to_dict() # create an instance of ValidationErrorLocInner from a dict validation_error_loc_inner_form_dict = validation_error_loc_inner.from_dict(validation_error_loc_inner_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) - -