IoSL/service-aware-frontend
3
0
Fork 0
generated from Luis/nextjs-python-web-template
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Trying to fix attach entity #44

Merged
merge-bot merged 8 commits from Qubasa-main into main 2024-01-08 19:57:51 +00:00
Conversation 0 Commits 8 Files Changed 44 +389 -420
19 changed files with 389 additions and 420 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 5f4eb1f521 - Show all commits

1
pkgs/clan-cli/clan_cli/webui/app.py
View File

@@ -33,6 +33,7 @@ for u in cors_url:
# Logging setup # Logging setup
log = logging.getLogger(__name__) log = logging.getLogger(__name__)
@asynccontextmanager @asynccontextmanager
async def lifespan(app: FastAPI) -> Any: async def lifespan(app: FastAPI) -> Any:
await socket_manager2.brd.connect() await socket_manager2.brd.connect()

135
pkgs/clan-cli/clan_cli/webui/routers/endpoints.py
View File

@@ -2,7 +2,6 @@ import logging
import time import time
from datetime import datetime from datetime import datetime
from typing import List, Optional from typing import List, Optional
import asyncio
import httpx import httpx
from fastapi import APIRouter, BackgroundTasks, Depends from fastapi import APIRouter, BackgroundTasks, Depends
@@ -16,7 +15,6 @@ from ..schemas import (
Resolution, Resolution,
Service, Service,
ServiceCreate, ServiceCreate,
ServicesByName,
) )
from ..tags import Tags from ..tags import Tags
@@ -46,9 +44,7 @@ def get_all_services(
return services return services
@router.get( @router.get("/api/v1/service", response_model=List[Service], tags=[Tags.services])
"/api/v1/service", response_model=List[Service], tags=[Tags.services]
)
def get_service_by_did( def get_service_by_did(
entity_did: str = "did:sov:test:1234", entity_did: str = "did:sov:test:1234",
skip: int = 0, skip: int = 0,
@@ -73,6 +69,7 @@ def get_services_without_entity(
service = sql_crud.get_services_without_entity_id(db, entity_did=entity_did) service = sql_crud.get_services_without_entity_id(db, entity_did=entity_did)
return service return service
@router.delete("/api/v1/service", tags=[Tags.services]) @router.delete("/api/v1/service", tags=[Tags.services])
def delete_service( def delete_service(
entity_did: str = "did:sov:test:1234", entity_did: str = "did:sov:test:1234",
@@ -129,9 +126,7 @@ def get_all_entities(
return entities return entities
@router.get( @router.get("/api/v1/entity", response_model=Optional[Entity], tags=[Tags.entities])
"/api/v1/entity", response_model=Optional[Entity], tags=[Tags.entities]
)
def get_entity_by_did( def get_entity_by_did(
entity_did: str = "did:sov:test:1234", entity_did: str = "did:sov:test:1234",
db: Session = Depends(sql_db.get_db), db: Session = Depends(sql_db.get_db),
@@ -151,11 +146,44 @@ def get_attached_entities(
entities = sql_crud.get_attached_entities(db, skip=skip, limit=limit) entities = sql_crud.get_attached_entities(db, skip=skip, limit=limit)
return entities return entities
@router.post("/api/v1/detach", tags=[Tags.entities])
def detach_entity(
background_tasks: BackgroundTasks,
entity_did: str = "did:sov:test:1234",
skip: int = 0,
limit: int = 100,
db: Session = Depends(sql_db.get_db),
) -> dict[str, str]:
entity = sql_crud.get_entity_by_did(db, did=entity_did)
if entity is None:
raise ClanError(f"Entity with did '{entity_did}' not found")
sql_crud.set_stop_health_task(db, entity_did, True)
return {"message": f"Detached {entity_did} successfully"}
@router.post("/api/v1/attach", tags=[Tags.entities])
def attach_entity(
background_tasks: BackgroundTasks,
entity_did: str = "did:sov:test:1234",
skip: int = 0,
limit: int = 100,
db: Session = Depends(sql_db.get_db),
) -> dict[str, str]:
entity = sql_crud.get_entity_by_did(db, did=entity_did)
if entity is None:
raise ClanError(f"Entity with did '{entity_did}' not found")
url = f"http://{entity.ip}"
sql_crud.set_stop_health_task(db, entity_did, False)
print("Start health query at", url)
background_tasks.add_task(attach_entity_loc, db, entity_did)
return {"message": f"Started attachment task for {entity.name}"}
@router.get("/api/v1/is_attached", tags=[Tags.entities]) @router.get("/api/v1/is_attached", tags=[Tags.entities])
def is_attached( def is_attached(
entity_did: str = "did:sov:test:1234", entity_did: str = "did:sov:test:1234", db: Session = Depends(sql_db.get_db)
db: Session = Depends(sql_db.get_db)) -> dict[str, str]: ) -> dict[str, str]:
entity = sql_crud.get_entity_by_did(db, did=entity_did) entity = sql_crud.get_entity_by_did(db, did=entity_did)
if entity is None: if entity is None:
@@ -171,74 +199,35 @@ def is_attached(
url = f"http://{entity.ip}" url = f"http://{entity.ip}"
raise ClanError(f"Entity at {url} not reachable") raise ClanError(f"Entity at {url} not reachable")
db.refresh(entity)
return {"message": f"Attached to {entity.name} successfully"} return {"message": f"Attached to {entity.name} successfully"}
def attach_entity_loc(db: Session, entity_did: str) -> None:
entity = sql_crud.get_entity_by_did(db, did=entity_did)
try:
assert entity is not None
url = f"http://{entity.ip}"
@router.post("/api/v1/detach", tags=[Tags.entities])
def detach_entity(
background_tasks: BackgroundTasks,
entity_did: str = "did:sov:test:1234",
skip: int = 0,
limit: int = 100,
db: Session = Depends(sql_db.get_db),
) -> dict[str, str]:
sql_crud.stop_entity_health_task(db, entity_did)
return {"message": f"Detached {entity_did} successfully"}
@router.post("/api/v1/attach", tags=[Tags.entities])
def attach_entity(
background_tasks: BackgroundTasks,
entity_did: str = "did:sov:test:1234",
skip: int = 0,
limit: int = 100
) -> dict[str, str]:
# entity = sql_crud.get_entity_by_did(db, did=entity_did)
# if entity is None:
# raise ClanError(f"Entity with did '{entity_did}' not found")
#url = f"http://{entity.ip}"
#log.info("Start health query at", url)
background_tasks.add_task(attach_entity_loc, entity_did)
return {"message": f"Started attachment task for {entity_did}"}
def attach_entity_loc(entity_did: str) -> None:
with sql_db.SessionLocal() as db:
entity = sql_crud.get_entity_by_did(db, did=entity_did)
while entity.stop_health_task is False: while entity.stop_health_task is False:
entity = sql_crud.get_entity_by_did(db, did=entity_did) response = httpx.get(url, timeout=2)
assert entity is not None if response.status_code != 200:
log.warning(f"Stop health status task for {entity.stop_health_task}") raise ClanError(
f"Entity with did '{entity_did}' returned {response.status_code}"
)
if entity.attached is False:
sql_crud.set_attached_by_entity_did(db, entity_did, True)
if entity is None:
raise ClanError(f"Entity with did '{entity_did}' has been deleted")
time.sleep(1) time.sleep(1)
# entity = sql_crud.get_entity_by_did(db, did=entity_did) db.refresh(entity)
# assert entity is not None except Exception:
# try: print(f"Entity {entity_did} not reachable at {url}")
finally:
# while True: sql_crud.set_attached_by_entity_did(db, entity_did, False)
sql_crud.set_stop_health_task(db, entity_did, False)
# if entity.stop_health_task:
# print(f"Stop health status task for {entity.name}")
# break
# url = f"http://{entity.ip}"
# response = httpx.get(url, timeout=2)
# #log.warning(f"Response {response.status_code} from {url}")
# print(f"{entity.name}: stop_health_task: {entity.stop_health_task}")
# if response.status_code != 200:
# raise ClanError(f"Entity with did '{entity_did}' returned {response.status_code}")
# if entity.attached is False:
# sql_crud.set_attached_by_entity_did(db, entity_did, True)
# if entity is None:
# raise ClanError(f"Entity with did '{entity_did}' has been deleted")
# time.sleep(1)
# except Exception:
# log.warning(f"Entity {entity_did} not reachable at {url}")
# finally:
# sql_crud.set_attached_by_entity_did(db, entity_did, False)
@router.delete("/api/v1/entity", tags=[Tags.entities]) @router.delete("/api/v1/entity", tags=[Tags.entities])

15
pkgs/clan-cli/clan_cli/webui/sql_crud.py
View File

@@ -64,7 +64,9 @@ def get_services_without_entity_id(
# # # #
######################### #########################
def create_entity(db: Session, entity: schemas.EntityCreate) -> sql_models.Entity: def create_entity(db: Session, entity: schemas.EntityCreate) -> sql_models.Entity:
db_entity = sql_models.Entity(**entity.dict(), attached=False, stop_health_task=False) db_entity = sql_models.Entity(
**entity.dict(), attached=False, stop_health_task=False
)
db.add(db_entity) db.add(db_entity)
db.commit() db.commit()
db.refresh(db_entity) db.refresh(db_entity)
@@ -100,14 +102,12 @@ def get_attached_entities(
# Returns same entity if setting didnt changed something # Returns same entity if setting didnt changed something
def stop_entity_health_task( def set_stop_health_task(db: Session, entity_did: str, value: bool) -> None:
db: Session, entity_did: str
) -> None:
db_entity = get_entity_by_did(db, entity_did) db_entity = get_entity_by_did(db, entity_did)
if db_entity is None: if db_entity is None:
raise ClanError(f"Entity with did '{entity_did}' not found") raise ClanError(f"Entity with did '{entity_did}' not found")
setattr(db_entity, "stop_health_task", True) setattr(db_entity, "stop_health_task", value)
# save changes in db # save changes in db
db.add(db_entity) db.add(db_entity)
@@ -115,10 +115,7 @@ def stop_entity_health_task(
db.refresh(db_entity) db.refresh(db_entity)
def set_attached_by_entity_did(db: Session, entity_did: str, attached: bool) -> None:
def set_attached_by_entity_did(
db: Session, entity_did: str, attached: bool
) -> None:
db_entity = get_entity_by_did(db, entity_did) db_entity = get_entity_by_did(db, entity_did)
if db_entity is None: if db_entity is None:
raise ClanError(f"Entity with did '{entity_did}' not found") raise ClanError(f"Entity with did '{entity_did}' not found")

2
pkgs/clan-cli/emulate_entity.sh
View File

@@ -1,3 +1,3 @@
#!/usr/bin/env bash #!/usr/bin/env bash
while true ; do printf 'HTTP/1.1 200 OK\r\n\r\ncool, thanks' | nc -l -N 127.0.0.1 7002 ; done while true ; do printf 'HTTP/1.1 200 OK\r\n\r\ncool, thanks' | nc -l -N 127.0.0.1 7002; done

68
pkgs/clan-cli/tests/openapi_client/docs/DefaultApi.md
View File

@@ -1,15 +1,15 @@
# openapi_client.DefaultApi # 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() > get()
Get Get
@@ -42,9 +42,8 @@ with openapi_client.ApiClient(configuration) as api_client:
print("Exception when calling DefaultApi->get: %s\n" % e) print("Exception when calling DefaultApi->get: %s\n" % e)
``` ```
### Parameters ### Parameters
This endpoint does not need any parameter. This endpoint does not need any parameter.
### Return type ### Return type
@@ -57,17 +56,19 @@ No authorization required
### HTTP request headers ### HTTP request headers
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/json - **Accept**: application/json
### HTTP response details ### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------| | Status code | Description | Response headers |
**200** | Successful Response | - | | ----------- | ------------------- | ---------------- |
| **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) [[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** # **health**
> Machine health() > Machine health()
Health Health
@@ -103,9 +104,8 @@ with openapi_client.ApiClient(configuration) as api_client:
print("Exception when calling DefaultApi->health: %s\n" % e) print("Exception when calling DefaultApi->health: %s\n" % e)
``` ```
### Parameters ### Parameters
This endpoint does not need any parameter. This endpoint does not need any parameter.
### Return type ### Return type
@@ -118,17 +118,19 @@ No authorization required
### HTTP request headers ### HTTP request headers
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/json - **Accept**: application/json
### HTTP response details ### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------| | Status code | Description | Response headers |
**200** | Successful Response | - | | ----------- | ------------------- | ---------------- |
| **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) [[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**
> root(path_name) > root(path_name)
Root Root
@@ -153,7 +155,7 @@ configuration = openapi_client.Configuration(
with openapi_client.ApiClient(configuration) as api_client: with openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class # Create an instance of the API class
api_instance = openapi_client.DefaultApi(api_client) api_instance = openapi_client.DefaultApi(api_client)
path_name = 'path_name_example' # str | path_name = 'path_name_example' # str |
try: try:
# Root # Root
@@ -162,13 +164,11 @@ with openapi_client.ApiClient(configuration) as api_client:
print("Exception when calling DefaultApi->root: %s\n" % e) print("Exception when calling DefaultApi->root: %s\n" % e)
``` ```
### Parameters ### Parameters
Name | Type | Description | Notes | Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- | ------------- | ------- | ----------- | ----- |
**path_name** | **str**| | | **path_name** | **str** | |
### Return type ### Return type
@@ -180,14 +180,14 @@ No authorization required
### HTTP request headers ### HTTP request headers
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/json - **Accept**: application/json
### HTTP response details ### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------| | Status code | Description | Response headers |
**200** | Successful Response | - | | ----------- | ------------------- | ---------------- |
**422** | Validation Error | - | | **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) [[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)

216
pkgs/clan-cli/tests/openapi_client/docs/EntitiesApi.md
View File

@@ -1,20 +1,20 @@
# openapi_client.EntitiesApi # 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
| 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** # **attach_entity**
> Dict[str, str] attach_entity(entity_did=entity_did, skip=skip, limit=limit) > Dict[str, str] attach_entity(entity_did=entity_did, skip=skip, limit=limit)
Attach Entity Attach Entity
@@ -52,15 +52,13 @@ with openapi_client.ApiClient(configuration) as api_client:
print("Exception when calling EntitiesApi->attach_entity: %s\n" % e) print("Exception when calling EntitiesApi->attach_entity: %s\n" % e)
``` ```
### Parameters ### Parameters
Name | Type | Description | Notes | Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- | -------------- | ------- | ----------- | --------------------------------------------------- |
**entity_did** | **str**| | [optional] [default to 'did:sov:test:1234'] | **entity_did** | **str** | | [optional] [default to 'did:sov:test:1234'] |
**skip** | **int**| | [optional] [default to 0] | **skip** | **int** | | [optional] [default to 0] |
**limit** | **int**| | [optional] [default to 100] | **limit** | **int** | | [optional] [default to 100] |
### Return type ### Return type
@@ -72,18 +70,20 @@ No authorization required
### HTTP request headers ### HTTP request headers
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/json - **Accept**: application/json
### HTTP response details ### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------| | Status code | Description | Response headers |
**200** | Successful Response | - | | ----------- | ------------------- | ---------------- |
**422** | Validation Error | - | | **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) [[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** # **create_entity**
> Entity create_entity(entity_create) > Entity create_entity(entity_create)
Create Entity Create Entity
@@ -110,7 +110,7 @@ configuration = openapi_client.Configuration(
with openapi_client.ApiClient(configuration) as api_client: with openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class # Create an instance of the API class
api_instance = openapi_client.EntitiesApi(api_client) api_instance = openapi_client.EntitiesApi(api_client)
entity_create = openapi_client.EntityCreate() # EntityCreate | entity_create = openapi_client.EntityCreate() # EntityCreate |
try: try:
# Create Entity # Create Entity
@@ -121,13 +121,11 @@ with openapi_client.ApiClient(configuration) as api_client:
print("Exception when calling EntitiesApi->create_entity: %s\n" % e) print("Exception when calling EntitiesApi->create_entity: %s\n" % e)
``` ```
### Parameters ### Parameters
Name | Type | Description | Notes | Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- | ----------------- | ----------------------------------- | ----------- | ----- |
**entity_create** | [**EntityCreate**](EntityCreate.md)| | | **entity_create** | [**EntityCreate**](EntityCreate.md) | |
### Return type ### Return type
@@ -139,18 +137,20 @@ No authorization required
### HTTP request headers ### HTTP request headers
- **Content-Type**: application/json - **Content-Type**: application/json
- **Accept**: application/json - **Accept**: application/json
### HTTP response details ### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------| | Status code | Description | Response headers |
**200** | Successful Response | - | | ----------- | ------------------- | ---------------- |
**422** | Validation Error | - | | **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) [[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** # **delete_entity**
> Dict[str, str] delete_entity(entity_did=entity_did) > Dict[str, str] delete_entity(entity_did=entity_did)
Delete Entity Delete Entity
@@ -186,13 +186,11 @@ with openapi_client.ApiClient(configuration) as api_client:
print("Exception when calling EntitiesApi->delete_entity: %s\n" % e) print("Exception when calling EntitiesApi->delete_entity: %s\n" % e)
``` ```
### Parameters ### Parameters
Name | Type | Description | Notes | Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- | -------------- | ------- | ----------- | --------------------------------------------------- |
**entity_did** | **str**| | [optional] [default to 'did:sov:test:1234'] | **entity_did** | **str** | | [optional] [default to 'did:sov:test:1234'] |
### Return type ### Return type
@@ -204,18 +202,20 @@ No authorization required
### HTTP request headers ### HTTP request headers
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/json - **Accept**: application/json
### HTTP response details ### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------| | Status code | Description | Response headers |
**200** | Successful Response | - | | ----------- | ------------------- | ---------------- |
**422** | Validation Error | - | | **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) [[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** # **detach_entity**
> Entity detach_entity(entity_did=entity_did, skip=skip, limit=limit) > Entity detach_entity(entity_did=entity_did, skip=skip, limit=limit)
Detach Entity Detach Entity
@@ -254,15 +254,13 @@ with openapi_client.ApiClient(configuration) as api_client:
print("Exception when calling EntitiesApi->detach_entity: %s\n" % e) print("Exception when calling EntitiesApi->detach_entity: %s\n" % e)
``` ```
### Parameters ### Parameters
Name | Type | Description | Notes | Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- | -------------- | ------- | ----------- | --------------------------------------------------- |
**entity_did** | **str**| | [optional] [default to 'did:sov:test:1234'] | **entity_did** | **str** | | [optional] [default to 'did:sov:test:1234'] |
**skip** | **int**| | [optional] [default to 0] | **skip** | **int** | | [optional] [default to 0] |
**limit** | **int**| | [optional] [default to 100] | **limit** | **int** | | [optional] [default to 100] |
### Return type ### Return type
@@ -274,18 +272,20 @@ No authorization required
### HTTP request headers ### HTTP request headers
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/json - **Accept**: application/json
### HTTP response details ### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------| | Status code | Description | Response headers |
**200** | Successful Response | - | | ----------- | ------------------- | ---------------- |
**422** | Validation Error | - | | **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) [[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** # **get_all_entities**
> List[Entity] get_all_entities(skip=skip, limit=limit) > List[Entity] get_all_entities(skip=skip, limit=limit)
Get All Entities 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) print("Exception when calling EntitiesApi->get_all_entities: %s\n" % e)
``` ```
### Parameters ### Parameters
Name | Type | Description | Notes | Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- | --------- | ------- | ----------- | --------------------------- |
**skip** | **int**| | [optional] [default to 0] | **skip** | **int** | | [optional] [default to 0] |
**limit** | **int**| | [optional] [default to 100] | **limit** | **int** | | [optional] [default to 100] |
### Return type ### Return type
@@ -342,18 +340,20 @@ No authorization required
### HTTP request headers ### HTTP request headers
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/json - **Accept**: application/json
### HTTP response details ### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------| | Status code | Description | Response headers |
**200** | Successful Response | - | | ----------- | ------------------- | ---------------- |
**422** | Validation Error | - | | **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) [[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** # **get_attached_entities**
> List[Entity] get_attached_entities(skip=skip, limit=limit) > List[Entity] get_attached_entities(skip=skip, limit=limit)
Get Attached Entities 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) print("Exception when calling EntitiesApi->get_attached_entities: %s\n" % e)
``` ```
### Parameters ### Parameters
Name | Type | Description | Notes | Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- | --------- | ------- | ----------- | --------------------------- |
**skip** | **int**| | [optional] [default to 0] | **skip** | **int** | | [optional] [default to 0] |
**limit** | **int**| | [optional] [default to 100] | **limit** | **int** | | [optional] [default to 100] |
### Return type ### Return type
@@ -410,18 +408,20 @@ No authorization required
### HTTP request headers ### HTTP request headers
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/json - **Accept**: application/json
### HTTP response details ### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------| | Status code | Description | Response headers |
**200** | Successful Response | - | | ----------- | ------------------- | ---------------- |
**422** | Validation Error | - | | **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) [[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** # **get_entity_by_did**
> Entity get_entity_by_did(entity_did=entity_did) > Entity get_entity_by_did(entity_did=entity_did)
Get Entity By 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) print("Exception when calling EntitiesApi->get_entity_by_did: %s\n" % e)
``` ```
### Parameters ### Parameters
Name | Type | Description | Notes | Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- | -------------- | ------- | ----------- | --------------------------------------------------- |
**entity_did** | **str**| | [optional] [default to 'did:sov:test:1234'] | **entity_did** | **str** | | [optional] [default to 'did:sov:test:1234'] |
### Return type ### Return type
@@ -476,18 +474,20 @@ No authorization required
### HTTP request headers ### HTTP request headers
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/json - **Accept**: application/json
### HTTP response details ### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------| | Status code | Description | Response headers |
**200** | Successful Response | - | | ----------- | ------------------- | ---------------- |
**422** | Validation Error | - | | **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) [[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** # **get_entity_by_name**
> Entity get_entity_by_name(entity_name) > Entity get_entity_by_name(entity_name)
Get Entity By Name Get Entity By Name
@@ -513,7 +513,7 @@ configuration = openapi_client.Configuration(
with openapi_client.ApiClient(configuration) as api_client: with openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class # Create an instance of the API class
api_instance = openapi_client.EntitiesApi(api_client) api_instance = openapi_client.EntitiesApi(api_client)
entity_name = 'entity_name_example' # str | entity_name = 'entity_name_example' # str |
try: try:
# Get Entity By Name # 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) print("Exception when calling EntitiesApi->get_entity_by_name: %s\n" % e)
``` ```
### Parameters ### Parameters
Name | Type | Description | Notes | Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- | --------------- | ------- | ----------- | ----- |
**entity_name** | **str**| | | **entity_name** | **str** | |
### Return type ### Return type
@@ -542,14 +540,14 @@ No authorization required
### HTTP request headers ### HTTP request headers
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/json - **Accept**: application/json
### HTTP response details ### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------| | Status code | Description | Response headers |
**200** | Successful Response | - | | ----------- | ------------------- | ---------------- |
**422** | Validation Error | - | | **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) [[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)

21
pkgs/clan-cli/tests/openapi_client/docs/Entity.md
View File

@@ -1,15 +1,15 @@
# Entity # Entity
## Properties ## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- | Name | Type | Description | Notes |
**did** | **str** | | | ------------ | ---------- | ----------- | ----- |
**name** | **str** | | | **did** | **str** | |
**ip** | **str** | | | **name** | **str** | |
**visible** | **bool** | | | **ip** | **str** | |
**other** | **object** | | | **visible** | **bool** | |
**attached** | **bool** | | | **other** | **object** | |
| **attached** | **bool** | |
## Example ## Example
@@ -28,6 +28,5 @@ entity_dict = entity_instance.to_dict()
# create an instance of Entity from a dict # create an instance of Entity from a dict
entity_form_dict = entity.from_dict(entity_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) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

19
pkgs/clan-cli/tests/openapi_client/docs/EntityCreate.md
View File

@@ -1,14 +1,14 @@
# EntityCreate # EntityCreate
## Properties ## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- | Name | Type | Description | Notes |
**did** | **str** | | | ----------- | ---------- | ----------- | ----- |
**name** | **str** | | | **did** | **str** | |
**ip** | **str** | | | **name** | **str** | |
**visible** | **bool** | | | **ip** | **str** | |
**other** | **object** | | | **visible** | **bool** | |
| **other** | **object** | |
## Example ## Example
@@ -27,6 +27,5 @@ entity_create_dict = entity_create_instance.to_dict()
# create an instance of EntityCreate from a dict # create an instance of EntityCreate from a dict
entity_create_form_dict = entity_create.from_dict(entity_create_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) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11
pkgs/clan-cli/tests/openapi_client/docs/HTTPValidationError.md
View File

@@ -1,10 +1,10 @@
# HTTPValidationError # HTTPValidationError
## Properties ## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- | Name | Type | Description | Notes |
**detail** | [**List[ValidationError]**](ValidationError.md) | | [optional] | ---------- | ----------------------------------------------- | ----------- | ---------- |
| **detail** | [**List[ValidationError]**](ValidationError.md) | | [optional] |
## Example ## Example
@@ -23,6 +23,5 @@ http_validation_error_dict = http_validation_error_instance.to_dict()
# create an instance of HTTPValidationError from a dict # create an instance of HTTPValidationError from a dict
http_validation_error_form_dict = http_validation_error.from_dict(http_validation_error_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) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

13
pkgs/clan-cli/tests/openapi_client/docs/Machine.md
View File

@@ -1,11 +1,11 @@
# Machine # Machine
## Properties ## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- | Name | Type | Description | Notes |
**name** | **str** | | | ---------- | ----------------------- | ----------- | ----- |
**status** | [**Status**](Status.md) | | | **name** | **str** | |
| **status** | [**Status**](Status.md) | |
## Example ## Example
@@ -24,6 +24,5 @@ machine_dict = machine_instance.to_dict()
# create an instance of Machine from a dict # create an instance of Machine from a dict
machine_form_dict = machine.from_dict(machine_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) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

34
pkgs/clan-cli/tests/openapi_client/docs/RepositoriesApi.md
View File

@@ -1,13 +1,13 @@
# openapi_client.RepositoriesApi # 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** # **get_all_repositories**
> List[Service] get_all_repositories(skip=skip, limit=limit) > List[Service] get_all_repositories(skip=skip, limit=limit)
Get All Repositories 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) print("Exception when calling RepositoriesApi->get_all_repositories: %s\n" % e)
``` ```
### Parameters ### Parameters
Name | Type | Description | Notes | Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- | --------- | ------- | ----------- | --------------------------- |
**skip** | **int**| | [optional] [default to 0] | **skip** | **int** | | [optional] [default to 0] |
**limit** | **int**| | [optional] [default to 100] | **limit** | **int** | | [optional] [default to 100] |
### Return type ### Return type
@@ -64,14 +62,14 @@ No authorization required
### HTTP request headers ### HTTP request headers
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/json - **Accept**: application/json
### HTTP response details ### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------| | Status code | Description | Response headers |
**200** | Successful Response | - | | ----------- | ------------------- | ---------------- |
**422** | Validation Error | - | | **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) [[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)

21
pkgs/clan-cli/tests/openapi_client/docs/Resolution.md
View File

@@ -1,15 +1,15 @@
# Resolution # Resolution
## Properties ## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- | Name | Type | Description | Notes |
**requester_name** | **str** | | | ------------------ | ------------ | ----------- | ----- |
**requester_did** | **str** | | | **requester_name** | **str** | |
**resolved_did** | **str** | | | **requester_did** | **str** | |
**other** | **object** | | | **resolved_did** | **str** | |
**timestamp** | **datetime** | | | **other** | **object** | |
**id** | **int** | | | **timestamp** | **datetime** | |
| **id** | **int** | |
## Example ## Example
@@ -28,6 +28,5 @@ resolution_dict = resolution_instance.to_dict()
# create an instance of Resolution from a dict # create an instance of Resolution from a dict
resolution_form_dict = resolution.from_dict(resolution_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) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

34
pkgs/clan-cli/tests/openapi_client/docs/ResolutionApi.md
View File

@@ -1,13 +1,13 @@
# openapi_client.ResolutionApi # 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** # **get_all_resolutions**
> List[Resolution] get_all_resolutions(skip=skip, limit=limit) > List[Resolution] get_all_resolutions(skip=skip, limit=limit)
Get All Resolutions 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) print("Exception when calling ResolutionApi->get_all_resolutions: %s\n" % e)
``` ```
### Parameters ### Parameters
Name | Type | Description | Notes | Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- | --------- | ------- | ----------- | --------------------------- |
**skip** | **int**| | [optional] [default to 0] | **skip** | **int** | | [optional] [default to 0] |
**limit** | **int**| | [optional] [default to 100] | **limit** | **int** | | [optional] [default to 100] |
### Return type ### Return type
@@ -64,14 +62,14 @@ No authorization required
### HTTP request headers ### HTTP request headers
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/json - **Accept**: application/json
### HTTP response details ### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------| | Status code | Description | Response headers |
**200** | Successful Response | - | | ----------- | ------------------- | ---------------- |
**422** | Validation Error | - | | **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) [[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)

25
pkgs/clan-cli/tests/openapi_client/docs/Service.md
View File

@@ -1,17 +1,17 @@
# Service # Service
## Properties ## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- | Name | Type | Description | Notes |
**uuid** | **str** | | | ---------------- | ----------------------- | ----------- | ----- |
**service_name** | **str** | | | **uuid** | **str** | |
**service_type** | **str** | | | **service_name** | **str** | |
**endpoint_url** | **str** | | | **service_type** | **str** | |
**status** | **str** | | | **endpoint_url** | **str** | |
**other** | **object** | | | **status** | **str** | |
**entity_did** | **str** | | | **other** | **object** | |
**entity** | [**Entity**](Entity.md) | | | **entity_did** | **str** | |
| **entity** | [**Entity**](Entity.md) | |
## Example ## Example
@@ -30,6 +30,5 @@ service_dict = service_instance.to_dict()
# create an instance of Service from a dict # create an instance of Service from a dict
service_form_dict = service.from_dict(service_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) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

23
pkgs/clan-cli/tests/openapi_client/docs/ServiceCreate.md
View File

@@ -1,16 +1,16 @@
# ServiceCreate # ServiceCreate
## Properties ## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- | Name | Type | Description | Notes |
**uuid** | **str** | | | ---------------- | ---------- | ----------- | ----- |
**service_name** | **str** | | | **uuid** | **str** | |
**service_type** | **str** | | | **service_name** | **str** | |
**endpoint_url** | **str** | | | **service_type** | **str** | |
**status** | **str** | | | **endpoint_url** | **str** | |
**other** | **object** | | | **status** | **str** | |
**entity_did** | **str** | | | **other** | **object** | |
| **entity_did** | **str** | |
## Example ## Example
@@ -29,6 +29,5 @@ service_create_dict = service_create_instance.to_dict()
# create an instance of ServiceCreate from a dict # create an instance of ServiceCreate from a dict
service_create_form_dict = service_create.from_dict(service_create_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) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

140
pkgs/clan-cli/tests/openapi_client/docs/ServicesApi.md
View File

@@ -1,17 +1,17 @@
# openapi_client.ServicesApi # 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** # **create_service**
> Service create_service(service_create) > Service create_service(service_create)
Create Service Create Service
@@ -38,7 +38,7 @@ configuration = openapi_client.Configuration(
with openapi_client.ApiClient(configuration) as api_client: with openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class # Create an instance of the API class
api_instance = openapi_client.ServicesApi(api_client) api_instance = openapi_client.ServicesApi(api_client)
service_create = openapi_client.ServiceCreate() # ServiceCreate | service_create = openapi_client.ServiceCreate() # ServiceCreate |
try: try:
# Create Service # Create Service
@@ -49,13 +49,11 @@ with openapi_client.ApiClient(configuration) as api_client:
print("Exception when calling ServicesApi->create_service: %s\n" % e) print("Exception when calling ServicesApi->create_service: %s\n" % e)
``` ```
### Parameters ### Parameters
Name | Type | Description | Notes | Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- | ------------------ | ------------------------------------- | ----------- | ----- |
**service_create** | [**ServiceCreate**](ServiceCreate.md)| | | **service_create** | [**ServiceCreate**](ServiceCreate.md) | |
### Return type ### Return type
@@ -67,18 +65,20 @@ No authorization required
### HTTP request headers ### HTTP request headers
- **Content-Type**: application/json - **Content-Type**: application/json
- **Accept**: application/json - **Accept**: application/json
### HTTP response details ### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------| | Status code | Description | Response headers |
**200** | Successful Response | - | | ----------- | ------------------- | ---------------- |
**422** | Validation Error | - | | **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) [[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** # **delete_service**
> Dict[str, str] delete_service(entity_did=entity_did) > Dict[str, str] delete_service(entity_did=entity_did)
Delete Service Delete Service
@@ -114,13 +114,11 @@ with openapi_client.ApiClient(configuration) as api_client:
print("Exception when calling ServicesApi->delete_service: %s\n" % e) print("Exception when calling ServicesApi->delete_service: %s\n" % e)
``` ```
### Parameters ### Parameters
Name | Type | Description | Notes | Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- | -------------- | ------- | ----------- | --------------------------------------------------- |
**entity_did** | **str**| | [optional] [default to 'did:sov:test:1234'] | **entity_did** | **str** | | [optional] [default to 'did:sov:test:1234'] |
### Return type ### Return type
@@ -132,18 +130,20 @@ No authorization required
### HTTP request headers ### HTTP request headers
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/json - **Accept**: application/json
### HTTP response details ### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------| | Status code | Description | Response headers |
**200** | Successful Response | - | | ----------- | ------------------- | ---------------- |
**422** | Validation Error | - | | **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) [[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** # **get_all_services**
> List[Service] get_all_services(skip=skip, limit=limit) > List[Service] get_all_services(skip=skip, limit=limit)
Get All Services 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) print("Exception when calling ServicesApi->get_all_services: %s\n" % e)
``` ```
### Parameters ### Parameters
Name | Type | Description | Notes | Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- | --------- | ------- | ----------- | --------------------------- |
**skip** | **int**| | [optional] [default to 0] | **skip** | **int** | | [optional] [default to 0] |
**limit** | **int**| | [optional] [default to 100] | **limit** | **int** | | [optional] [default to 100] |
### Return type ### Return type
@@ -200,18 +198,20 @@ No authorization required
### HTTP request headers ### HTTP request headers
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/json - **Accept**: application/json
### HTTP response details ### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------| | Status code | Description | Response headers |
**200** | Successful Response | - | | ----------- | ------------------- | ---------------- |
**422** | Validation Error | - | | **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) [[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** # **get_service_by_did**
> List[Service] get_service_by_did(entity_did=entity_did, skip=skip, limit=limit) > List[Service] get_service_by_did(entity_did=entity_did, skip=skip, limit=limit)
Get Service By Did 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) print("Exception when calling ServicesApi->get_service_by_did: %s\n" % e)
``` ```
### Parameters ### Parameters
Name | Type | Description | Notes | Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- | -------------- | ------- | ----------- | --------------------------------------------------- |
**entity_did** | **str**| | [optional] [default to 'did:sov:test:1234'] | **entity_did** | **str** | | [optional] [default to 'did:sov:test:1234'] |
**skip** | **int**| | [optional] [default to 0] | **skip** | **int** | | [optional] [default to 0] |
**limit** | **int**| | [optional] [default to 100] | **limit** | **int** | | [optional] [default to 100] |
### Return type ### Return type
@@ -270,18 +268,20 @@ No authorization required
### HTTP request headers ### HTTP request headers
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/json - **Accept**: application/json
### HTTP response details ### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------| | Status code | Description | Response headers |
**200** | Successful Response | - | | ----------- | ------------------- | ---------------- |
**422** | Validation Error | - | | **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) [[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** # **get_services_without_entity**
> List[Service] get_services_without_entity(entity_did=entity_did, skip=skip, limit=limit) > List[Service] get_services_without_entity(entity_did=entity_did, skip=skip, limit=limit)
Get Services Without Entity 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) print("Exception when calling ServicesApi->get_services_without_entity: %s\n" % e)
``` ```
### Parameters ### Parameters
Name | Type | Description | Notes | Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- | -------------- | ------- | ----------- | --------------------------------------------------- |
**entity_did** | **str**| | [optional] [default to 'did:sov:test:1234'] | **entity_did** | **str** | | [optional] [default to 'did:sov:test:1234'] |
**skip** | **int**| | [optional] [default to 0] | **skip** | **int** | | [optional] [default to 0] |
**limit** | **int**| | [optional] [default to 100] | **limit** | **int** | | [optional] [default to 100] |
### Return type ### Return type
@@ -340,14 +338,14 @@ No authorization required
### HTTP request headers ### HTTP request headers
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/json - **Accept**: application/json
### HTTP response details ### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------| | Status code | Description | Response headers |
**200** | Successful Response | - | | ----------- | ------------------- | ---------------- |
**422** | Validation Error | - | | **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) [[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)

7
pkgs/clan-cli/tests/openapi_client/docs/Status.md
View File

@@ -3,9 +3,8 @@
An enumeration. An enumeration.
## Properties ## 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) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

15
pkgs/clan-cli/tests/openapi_client/docs/ValidationError.md
View File

@@ -1,12 +1,12 @@
# ValidationError # ValidationError
## Properties ## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- | Name | Type | Description | Notes |
**loc** | [**List[ValidationErrorLocInner]**](ValidationErrorLocInner.md) | | | -------- | --------------------------------------------------------------- | ----------- | ----- |
**msg** | **str** | | | **loc** | [**List[ValidationErrorLocInner]**](ValidationErrorLocInner.md) | |
**type** | **str** | | | **msg** | **str** | |
| **type** | **str** | |
## Example ## Example
@@ -25,6 +25,5 @@ validation_error_dict = validation_error_instance.to_dict()
# create an instance of ValidationError from a dict # create an instance of ValidationError from a dict
validation_error_form_dict = validation_error.from_dict(validation_error_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) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

9
pkgs/clan-cli/tests/openapi_client/docs/ValidationErrorLocInner.md
View File

@@ -1,9 +1,9 @@
# ValidationErrorLocInner # ValidationErrorLocInner
## Properties ## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- | Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
## Example ## 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 # 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) 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) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)