generated from Luis/nextjs-python-web-template
new openapi_client
This commit is contained in:
@@ -486,7 +486,7 @@ class EntitiesApi:
|
||||
_request_auth=_params.get('_request_auth'))
|
||||
|
||||
@validate_arguments
|
||||
def detach_entity(self, entity_did : Optional[StrictStr] = None, skip : Optional[StrictInt] = None, limit : Optional[StrictInt] = None, **kwargs) -> Entity: # noqa: E501
|
||||
def detach_entity(self, entity_did : Optional[StrictStr] = None, skip : Optional[StrictInt] = None, limit : Optional[StrictInt] = None, **kwargs) -> Dict[str, str]: # noqa: E501
|
||||
"""Detach Entity # noqa: E501
|
||||
|
||||
This method makes a synchronous HTTP request by default. To make an
|
||||
@@ -510,7 +510,7 @@ class EntitiesApi:
|
||||
:return: Returns the result object.
|
||||
If the method is called asynchronously,
|
||||
returns the request thread.
|
||||
:rtype: Entity
|
||||
:rtype: Dict[str, str]
|
||||
"""
|
||||
kwargs['_return_http_data_only'] = True
|
||||
if '_preload_content' in kwargs:
|
||||
@@ -556,7 +556,7 @@ class EntitiesApi:
|
||||
:return: Returns the result object.
|
||||
If the method is called asynchronously,
|
||||
returns the request thread.
|
||||
:rtype: tuple(Entity, status_code(int), headers(HTTPHeaderDict))
|
||||
:rtype: tuple(Dict[str, str], status_code(int), headers(HTTPHeaderDict))
|
||||
"""
|
||||
|
||||
_params = locals()
|
||||
@@ -619,7 +619,7 @@ class EntitiesApi:
|
||||
_auth_settings = [] # noqa: E501
|
||||
|
||||
_response_types_map = {
|
||||
'200': "Entity",
|
||||
'200': "Dict[str, str]",
|
||||
'422': "HTTPValidationError",
|
||||
}
|
||||
|
||||
@@ -1211,3 +1211,142 @@ class EntitiesApi:
|
||||
_request_timeout=_params.get('_request_timeout'),
|
||||
collection_formats=_collection_formats,
|
||||
_request_auth=_params.get('_request_auth'))
|
||||
|
||||
@validate_arguments
|
||||
def is_attached(self, entity_did : Optional[StrictStr] = None, **kwargs) -> Dict[str, str]: # noqa: E501
|
||||
"""Is Attached # noqa: E501
|
||||
|
||||
This method makes a synchronous HTTP request by default. To make an
|
||||
asynchronous HTTP request, please pass async_req=True
|
||||
|
||||
>>> thread = api.is_attached(entity_did, async_req=True)
|
||||
>>> result = thread.get()
|
||||
|
||||
:param entity_did:
|
||||
:type entity_did: str
|
||||
:param async_req: Whether to execute the request asynchronously.
|
||||
:type async_req: bool, optional
|
||||
:param _request_timeout: timeout setting for this request.
|
||||
If one number provided, it will be total request
|
||||
timeout. It can also be a pair (tuple) of
|
||||
(connection, read) timeouts.
|
||||
:return: Returns the result object.
|
||||
If the method is called asynchronously,
|
||||
returns the request thread.
|
||||
:rtype: Dict[str, str]
|
||||
"""
|
||||
kwargs['_return_http_data_only'] = True
|
||||
if '_preload_content' in kwargs:
|
||||
message = "Error! Please call the is_attached_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
|
||||
raise ValueError(message)
|
||||
return self.is_attached_with_http_info(entity_did, **kwargs) # noqa: E501
|
||||
|
||||
@validate_arguments
|
||||
def is_attached_with_http_info(self, entity_did : Optional[StrictStr] = None, **kwargs) -> ApiResponse: # noqa: E501
|
||||
"""Is Attached # noqa: E501
|
||||
|
||||
This method makes a synchronous HTTP request by default. To make an
|
||||
asynchronous HTTP request, please pass async_req=True
|
||||
|
||||
>>> thread = api.is_attached_with_http_info(entity_did, async_req=True)
|
||||
>>> result = thread.get()
|
||||
|
||||
:param entity_did:
|
||||
:type entity_did: str
|
||||
:param async_req: Whether to execute the request asynchronously.
|
||||
:type async_req: bool, optional
|
||||
:param _preload_content: if False, the ApiResponse.data will
|
||||
be set to none and raw_data will store the
|
||||
HTTP response body without reading/decoding.
|
||||
Default is True.
|
||||
:type _preload_content: bool, optional
|
||||
:param _return_http_data_only: response data instead of ApiResponse
|
||||
object with status code, headers, etc
|
||||
:type _return_http_data_only: bool, optional
|
||||
:param _request_timeout: timeout setting for this request. If one
|
||||
number provided, it will be total request
|
||||
timeout. It can also be a pair (tuple) of
|
||||
(connection, read) timeouts.
|
||||
:param _request_auth: set to override the auth_settings for an a single
|
||||
request; this effectively ignores the authentication
|
||||
in the spec for a single request.
|
||||
:type _request_auth: dict, optional
|
||||
:type _content_type: string, optional: force content-type for the request
|
||||
:return: Returns the result object.
|
||||
If the method is called asynchronously,
|
||||
returns the request thread.
|
||||
:rtype: tuple(Dict[str, str], status_code(int), headers(HTTPHeaderDict))
|
||||
"""
|
||||
|
||||
_params = locals()
|
||||
|
||||
_all_params = [
|
||||
'entity_did'
|
||||
]
|
||||
_all_params.extend(
|
||||
[
|
||||
'async_req',
|
||||
'_return_http_data_only',
|
||||
'_preload_content',
|
||||
'_request_timeout',
|
||||
'_request_auth',
|
||||
'_content_type',
|
||||
'_headers'
|
||||
]
|
||||
)
|
||||
|
||||
# validate the arguments
|
||||
for _key, _val in _params['kwargs'].items():
|
||||
if _key not in _all_params:
|
||||
raise ApiTypeError(
|
||||
"Got an unexpected keyword argument '%s'"
|
||||
" to method is_attached" % _key
|
||||
)
|
||||
_params[_key] = _val
|
||||
del _params['kwargs']
|
||||
|
||||
_collection_formats = {}
|
||||
|
||||
# process the path parameters
|
||||
_path_params = {}
|
||||
|
||||
# process the query parameters
|
||||
_query_params = []
|
||||
if _params.get('entity_did') is not None: # noqa: E501
|
||||
_query_params.append(('entity_did', _params['entity_did']))
|
||||
|
||||
# process the header parameters
|
||||
_header_params = dict(_params.get('_headers', {}))
|
||||
# process the form parameters
|
||||
_form_params = []
|
||||
_files = {}
|
||||
# process the body parameter
|
||||
_body_params = None
|
||||
# set the HTTP header `Accept`
|
||||
_header_params['Accept'] = self.api_client.select_header_accept(
|
||||
['application/json']) # noqa: E501
|
||||
|
||||
# authentication setting
|
||||
_auth_settings = [] # noqa: E501
|
||||
|
||||
_response_types_map = {
|
||||
'200': "Dict[str, str]",
|
||||
'422': "HTTPValidationError",
|
||||
}
|
||||
|
||||
return self.api_client.call_api(
|
||||
'/api/v1/is_attached', 'GET',
|
||||
_path_params,
|
||||
_query_params,
|
||||
_header_params,
|
||||
body=_body_params,
|
||||
post_params=_form_params,
|
||||
files=_files,
|
||||
response_types_map=_response_types_map,
|
||||
auth_settings=_auth_settings,
|
||||
async_req=_params.get('async_req'),
|
||||
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
|
||||
_preload_content=_params.get('_preload_content', True),
|
||||
_request_timeout=_params.get('_request_timeout'),
|
||||
collection_formats=_collection_formats,
|
||||
_request_auth=_params.get('_request_auth'))
|
||||
|
||||
@@ -1,15 +1,15 @@
|
||||
# openapi_client.DefaultApi
|
||||
|
||||
All URIs are relative to _http://localhost_
|
||||
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
|
||||
|
||||
| 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,8 +42,9 @@ with openapi_client.ApiClient(configuration) as api_client:
|
||||
print("Exception when calling DefaultApi->get: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
@@ -56,19 +57,17 @@ 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
|
||||
@@ -104,8 +103,9 @@ with openapi_client.ApiClient(configuration) as api_client:
|
||||
print("Exception when calling DefaultApi->health: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
@@ -118,19 +118,17 @@ 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
|
||||
@@ -155,7 +153,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
|
||||
@@ -164,11 +162,13 @@ 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)
|
||||
|
||||
|
||||
@@ -1,20 +1,21 @@
|
||||
# openapi_client.EntitiesApi
|
||||
|
||||
All URIs are relative to _http://localhost_
|
||||
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
|
||||
|
||||
| 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 |
|
||||
|
||||
# **attach_entity**
|
||||
|
||||
> Dict[str, str] attach_entity(entity_did=entity_did, skip=skip, limit=limit)
|
||||
|
||||
Attach Entity
|
||||
@@ -52,13 +53,15 @@ 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
|
||||
|
||||
@@ -70,20 +73,18 @@ 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
|
||||
@@ -110,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
|
||||
@@ -121,11 +122,13 @@ 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
|
||||
|
||||
@@ -137,20 +140,18 @@ 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
|
||||
@@ -186,11 +187,13 @@ 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
|
||||
|
||||
@@ -202,21 +205,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 | - |
|
||||
| **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**
|
||||
|
||||
> Entity detach_entity(entity_did=entity_did, skip=skip, limit=limit)
|
||||
> Dict[str, str] detach_entity(entity_did=entity_did, skip=skip, limit=limit)
|
||||
|
||||
Detach Entity
|
||||
|
||||
@@ -226,7 +227,6 @@ Detach Entity
|
||||
import time
|
||||
import os
|
||||
import openapi_client
|
||||
from openapi_client.models.entity import Entity
|
||||
from openapi_client.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
@@ -254,17 +254,19 @@ 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
|
||||
|
||||
[**Entity**](Entity.md)
|
||||
**Dict[str, str]**
|
||||
|
||||
### Authorization
|
||||
|
||||
@@ -272,20 +274,18 @@ 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,12 +323,14 @@ 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
|
||||
|
||||
@@ -340,20 +342,18 @@ 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,12 +391,14 @@ 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
|
||||
|
||||
@@ -408,20 +410,18 @@ 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,11 +458,13 @@ 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
|
||||
|
||||
@@ -474,20 +476,18 @@ 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,11 +524,13 @@ 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
|
||||
|
||||
@@ -540,14 +542,79 @@ 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
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
import time
|
||||
import os
|
||||
import openapi_client
|
||||
from openapi_client.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# Defining the host is optional and defaults to http://localhost
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client.Configuration(
|
||||
host = "http://localhost"
|
||||
)
|
||||
|
||||
|
||||
# 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.EntitiesApi(api_client)
|
||||
entity_did = 'did:sov:test:1234' # str | (optional) (default to 'did:sov:test:1234')
|
||||
|
||||
try:
|
||||
# Is Attached
|
||||
api_response = api_instance.is_attached(entity_did=entity_did)
|
||||
print("The response of EntitiesApi->is_attached:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
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']
|
||||
|
||||
### Return type
|
||||
|
||||
**Dict[str, str]**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | Successful Response | - |
|
||||
**422** | Validation Error | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@@ -1,15 +1,16 @@
|
||||
# Entity
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ------------ | ---------- | ----------- | ----- |
|
||||
| **did** | **str** | |
|
||||
| **name** | **str** | |
|
||||
| **ip** | **str** | |
|
||||
| **visible** | **bool** | |
|
||||
| **other** | **object** | |
|
||||
| **attached** | **bool** | |
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**did** | **str** | |
|
||||
**name** | **str** | |
|
||||
**ip** | **str** | |
|
||||
**visible** | **bool** | |
|
||||
**other** | **object** | |
|
||||
**attached** | **bool** | |
|
||||
**stop_health_task** | **bool** | |
|
||||
|
||||
## Example
|
||||
|
||||
@@ -28,5 +29,6 @@ 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)
|
||||
|
||||
|
||||
|
||||
@@ -1,14 +1,14 @@
|
||||
# EntityCreate
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ----------- | ---------- | ----------- | ----- |
|
||||
| **did** | **str** | |
|
||||
| **name** | **str** | |
|
||||
| **ip** | **str** | |
|
||||
| **visible** | **bool** | |
|
||||
| **other** | **object** | |
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**did** | **str** | |
|
||||
**name** | **str** | |
|
||||
**ip** | **str** | |
|
||||
**visible** | **bool** | |
|
||||
**other** | **object** | |
|
||||
|
||||
## Example
|
||||
|
||||
@@ -27,5 +27,6 @@ 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)
|
||||
|
||||
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
# HTTPValidationError
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---------- | ----------------------------------------------- | ----------- | ---------- |
|
||||
| **detail** | [**List[ValidationError]**](ValidationError.md) | | [optional] |
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**detail** | [**List[ValidationError]**](ValidationError.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
@@ -23,5 +23,6 @@ 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)
|
||||
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
# Machine
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---------- | ----------------------- | ----------- | ----- |
|
||||
| **name** | **str** | |
|
||||
| **status** | [**Status**](Status.md) | |
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **str** | |
|
||||
**status** | [**Status**](Status.md) | |
|
||||
|
||||
## Example
|
||||
|
||||
@@ -24,5 +24,6 @@ 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)
|
||||
|
||||
|
||||
|
||||
@@ -1,13 +1,13 @@
|
||||
# openapi_client.RepositoriesApi
|
||||
|
||||
All URIs are relative to _http://localhost_
|
||||
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
|
||||
|
||||
| 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,12 +45,14 @@ 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
|
||||
|
||||
@@ -62,14 +64,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)
|
||||
|
||||
|
||||
@@ -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** | |
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**requester_name** | **str** | |
|
||||
**requester_did** | **str** | |
|
||||
**resolved_did** | **str** | |
|
||||
**other** | **object** | |
|
||||
**timestamp** | **datetime** | |
|
||||
**id** | **int** | |
|
||||
|
||||
## Example
|
||||
|
||||
@@ -28,5 +28,6 @@ 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)
|
||||
|
||||
|
||||
|
||||
@@ -1,13 +1,13 @@
|
||||
# openapi_client.ResolutionApi
|
||||
|
||||
All URIs are relative to _http://localhost_
|
||||
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
|
||||
|
||||
| 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,12 +45,14 @@ 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
|
||||
|
||||
@@ -62,14 +64,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)
|
||||
|
||||
|
||||
@@ -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) | |
|
||||
## 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) | |
|
||||
|
||||
## Example
|
||||
|
||||
@@ -30,5 +30,6 @@ 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)
|
||||
|
||||
|
||||
|
||||
@@ -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** | |
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**uuid** | **str** | |
|
||||
**service_name** | **str** | |
|
||||
**service_type** | **str** | |
|
||||
**endpoint_url** | **str** | |
|
||||
**status** | **str** | |
|
||||
**other** | **object** | |
|
||||
**entity_did** | **str** | |
|
||||
|
||||
## Example
|
||||
|
||||
@@ -29,5 +29,6 @@ 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)
|
||||
|
||||
|
||||
|
||||
@@ -1,17 +1,17 @@
|
||||
# openapi_client.ServicesApi
|
||||
|
||||
All URIs are relative to _http://localhost_
|
||||
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
|
||||
|
||||
| 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,11 +49,13 @@ 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
|
||||
|
||||
@@ -65,20 +67,18 @@ 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,11 +114,13 @@ 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
|
||||
|
||||
@@ -130,20 +132,18 @@ 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,12 +181,14 @@ 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
|
||||
|
||||
@@ -198,20 +200,18 @@ 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,13 +250,15 @@ 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
|
||||
|
||||
@@ -268,20 +270,18 @@ 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,13 +320,15 @@ 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
|
||||
|
||||
@@ -338,14 +340,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)
|
||||
|
||||
|
||||
@@ -3,8 +3,9 @@
|
||||
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)
|
||||
|
||||
|
||||
|
||||
@@ -1,12 +1,12 @@
|
||||
# ValidationError
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| -------- | --------------------------------------------------------------- | ----------- | ----- |
|
||||
| **loc** | [**List[ValidationErrorLocInner]**](ValidationErrorLocInner.md) | |
|
||||
| **msg** | **str** | |
|
||||
| **type** | **str** | |
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**loc** | [**List[ValidationErrorLocInner]**](ValidationErrorLocInner.md) | |
|
||||
**msg** | **str** | |
|
||||
**type** | **str** | |
|
||||
|
||||
## Example
|
||||
|
||||
@@ -25,5 +25,6 @@ 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)
|
||||
|
||||
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
# ValidationErrorLocInner
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ---- | ---- | ----------- | ----- |
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
## Example
|
||||
|
||||
@@ -22,5 +22,6 @@ 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)
|
||||
|
||||
|
||||
|
||||
@@ -31,7 +31,8 @@ class Entity(BaseModel):
|
||||
visible: StrictBool = Field(...)
|
||||
other: Dict[str, Any] = Field(...)
|
||||
attached: StrictBool = Field(...)
|
||||
__properties = ["did", "name", "ip", "visible", "other", "attached"]
|
||||
stop_health_task: StrictBool = Field(...)
|
||||
__properties = ["did", "name", "ip", "visible", "other", "attached", "stop_health_task"]
|
||||
|
||||
class Config:
|
||||
"""Pydantic configuration"""
|
||||
@@ -74,7 +75,8 @@ class Entity(BaseModel):
|
||||
"ip": obj.get("ip"),
|
||||
"visible": obj.get("visible"),
|
||||
"other": obj.get("other"),
|
||||
"attached": obj.get("attached")
|
||||
"attached": obj.get("attached"),
|
||||
"stop_health_task": obj.get("stop_health_task")
|
||||
})
|
||||
return _obj
|
||||
|
||||
|
||||
@@ -82,6 +82,13 @@ class TestEntitiesApi(unittest.TestCase):
|
||||
"""
|
||||
pass
|
||||
|
||||
def test_is_attached(self) -> None:
|
||||
"""Test case for is_attached
|
||||
|
||||
Is Attached # noqa: E501
|
||||
"""
|
||||
pass
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
unittest.main()
|
||||
|
||||
@@ -41,7 +41,8 @@ class TestEntity(unittest.TestCase):
|
||||
ip = '127.0.0.1',
|
||||
visible = True,
|
||||
other = {network=Carlos Home Network, roles=[service repository, service prosumer]},
|
||||
attached = True
|
||||
attached = True,
|
||||
stop_health_task = True
|
||||
)
|
||||
else:
|
||||
return Entity(
|
||||
@@ -51,6 +52,7 @@ class TestEntity(unittest.TestCase):
|
||||
visible = True,
|
||||
other = {network=Carlos Home Network, roles=[service repository, service prosumer]},
|
||||
attached = True,
|
||||
stop_health_task = True,
|
||||
)
|
||||
"""
|
||||
|
||||
|
||||
@@ -49,7 +49,8 @@ class TestService(unittest.TestCase):
|
||||
ip = '127.0.0.1',
|
||||
visible = True,
|
||||
other = {network=Carlos Home Network, roles=[service repository, service prosumer]},
|
||||
attached = True, )
|
||||
attached = True,
|
||||
stop_health_task = True, )
|
||||
)
|
||||
else:
|
||||
return Service(
|
||||
@@ -66,7 +67,8 @@ class TestService(unittest.TestCase):
|
||||
ip = '127.0.0.1',
|
||||
visible = True,
|
||||
other = {network=Carlos Home Network, roles=[service repository, service prosumer]},
|
||||
attached = True, ),
|
||||
attached = True,
|
||||
stop_health_task = True, ),
|
||||
)
|
||||
"""
|
||||
|
||||
|
||||
Reference in New Issue
Block a user