Stash changes

This commit is contained in:
2024-01-07 13:35:22 +01:00
parent aa664dfce1
commit bd30682092
38 changed files with 661 additions and 446 deletions

View File

@@ -2,15 +2,15 @@
All URIs are relative to _http://localhost_
| Method | HTTP request | Description |
| ---------------------------------------------------- | ------------------------------------ | --------------- |
| [**get_all_clients**](ClientsApi.md#get_all_clients) | **GET** /api/v1/{entity_did}/clients | Get All Clients |
| Method | HTTP request | Description |
| ---------------------------------------------------------- | ------------------------------------ | ------------------ |
| [**get_clients_by_did**](ClientsApi.md#get_clients_by_did) | **GET** /api/v1/{entity_did}/clients | Get Clients By Did |
# **get_all_clients**
# **get_clients_by_did**
> List[Service] get_all_clients(entity_did, skip=skip, limit=limit)
> List[Service] get_clients_by_did(entity_did, skip=skip, limit=limit)
Get All Clients
Get Clients By Did
### Example
@@ -38,12 +38,12 @@ with openapi_client.ApiClient(configuration) as api_client:
limit = 100 # int | (optional) (default to 100)
try:
# Get All Clients
api_response = api_instance.get_all_clients(entity_did, skip=skip, limit=limit)
print("The response of ClientsApi->get_all_clients:\n")
# Get Clients By Did
api_response = api_instance.get_clients_by_did(entity_did, skip=skip, limit=limit)
print("The response of ClientsApi->get_clients_by_did:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ClientsApi->get_all_clients: %s\n" % e)
print("Exception when calling ClientsApi->get_clients_by_did: %s\n" % e)
```
### Parameters

View File

@@ -11,6 +11,7 @@ All URIs are relative to _http://localhost_
| [**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_did}/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**
@@ -484,3 +485,69 @@ No authorization required
| **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
### Example
```python
import time
import os
import openapi_client
from openapi_client.models.entity import Entity
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_name = 'entity_name_example' # str |
try:
# Get Entity By Name
api_response = api_instance.get_entity_by_name(entity_name)
print("The response of EntitiesApi->get_entity_by_name:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling EntitiesApi->get_entity_by_name: %s\n" % e)
```
### Parameters
| Name | Type | Description | Notes |
| --------------- | ------- | ----------- | ----- |
| **entity_name** | **str** | |
### Return type
[**Entity**](Entity.md)
### 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)

View File

@@ -2,13 +2,13 @@
## Properties
| Name | Type | Description | Notes |
| ------------ | ---------- | ----------- | ------------------------------------------- |
| **did** | **str** | | [optional] [default to 'did:sov:test:1234'] |
| **name** | **str** | | [optional] [default to 'C1'] |
| **ip** | **str** | | [optional] [default to '127.0.0.1'] |
| **visible** | **bool** | | [optional] [default to True] |
| **other** | **object** | | [optional] |
| Name | Type | Description | Notes |
| ------------ | ---------- | ----------- | ----- |
| **did** | **str** | |
| **name** | **str** | |
| **ip** | **str** | |
| **visible** | **bool** | |
| **other** | **object** | |
| **attached** | **bool** | |
## Example

View File

@@ -2,13 +2,13 @@
## Properties
| Name | Type | Description | Notes |
| ----------- | ---------- | ----------- | ------------------------------------------- |
| **did** | **str** | | [optional] [default to 'did:sov:test:1234'] |
| **name** | **str** | | [optional] [default to 'C1'] |
| **ip** | **str** | | [optional] [default to '127.0.0.1'] |
| **visible** | **bool** | | [optional] [default to True] |
| **other** | **object** | | [optional] |
| Name | Type | Description | Notes |
| ----------- | ---------- | ----------- | ----- |
| **did** | **str** | |
| **name** | **str** | |
| **ip** | **str** | |
| **visible** | **bool** | |
| **other** | **object** | |
## Example

View File

@@ -2,12 +2,12 @@
## Properties
| Name | Type | Description | Notes |
| ------------------ | ------------ | ----------- | ------------------------------------------- |
| **requester_name** | **str** | | [optional] [default to 'C1'] |
| **requester_did** | **str** | | [optional] [default to 'did:sov:test:1122'] |
| **resolved_did** | **str** | | [optional] [default to 'did:sov:test:1234'] |
| **other** | **object** | | [optional] |
| Name | Type | Description | Notes |
| ------------------ | ------------ | ----------- | ----- |
| **requester_name** | **str** | |
| **requester_did** | **str** | |
| **resolved_did** | **str** | |
| **other** | **object** | |
| **timestamp** | **datetime** | |
| **id** | **int** | |

View File

@@ -2,15 +2,16 @@
## Properties
| Name | Type | Description | Notes |
| ---------------- | ---------- | ----------- | -------------------------------------------------------------- |
| **uuid** | **str** | | [optional] [default to '8e285c0c-4e40-430a-a477-26b3b81e30df'] |
| **service_name** | **str** | | [optional] [default to 'Carlos Printing'] |
| **service_type** | **str** | | [optional] [default to '3D Printing'] |
| **endpoint_url** | **str** | | [optional] [default to 'http://127.0.0.1:8000'] |
| **status** | **str** | | [optional] [default to 'unknown'] |
| **other** | **object** | | [optional] |
| **entity_did** | **str** | | [optional] [default to 'did:sov:test:1234'] |
| 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

View File

@@ -2,15 +2,15 @@
## Properties
| Name | Type | Description | Notes |
| ---------------- | ---------- | ----------- | -------------------------------------------------------------- |
| **uuid** | **str** | | [optional] [default to '8e285c0c-4e40-430a-a477-26b3b81e30df'] |
| **service_name** | **str** | | [optional] [default to 'Carlos Printing'] |
| **service_type** | **str** | | [optional] [default to '3D Printing'] |
| **endpoint_url** | **str** | | [optional] [default to 'http://127.0.0.1:8000'] |
| **status** | **str** | | [optional] [default to 'unknown'] |
| **other** | **object** | | [optional] |
| **entity_did** | **str** | | [optional] [default to 'did:sov:test:1234'] |
| Name | Type | Description | Notes |
| ---------------- | ---------- | ----------- | ----- |
| **uuid** | **str** | |
| **service_name** | **str** | |
| **service_type** | **str** | |
| **endpoint_url** | **str** | |
| **status** | **str** | |
| **other** | **object** | |
| **entity_did** | **str** | |
## Example