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

backend with --emulate flag

Browse Source
This commit is contained in:
Georg-Stahn
2024-01-11 15:34:01 +01:00
parent b679382622
commit b01b01a959
27 changed files with 699 additions and 538 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
pkgs/clan-cli/clan_cli/webui/__init__.py
View File

@@ -28,6 +28,12 @@ def register_parser(parser: argparse.ArgumentParser) -> None:
help="Populate the database with dummy data", help="Populate the database with dummy data",
default=False, default=False,
) )
parser.add_argument(
"--emulate",
action="store_true",
help="Emulate two entities c1 and c2 + dlg and ap",
default=False,
)
parser.add_argument( parser.add_argument(
"--no-open", action="store_true", help="Don't open the browser", default=False "--no-open", action="store_true", help="Don't open the browser", default=False
) )

27
pkgs/clan-cli/clan_cli/webui/server.py
View File

@@ -127,22 +127,31 @@ def start_server(args: argparse.Namespace) -> None:
subprocess.run(cmd, check=True) subprocess.run(cmd, check=True)
if args.emulate: if args.emulate:
# todo move emu
from .emulate_fastapi import (app_dlg, app_ap, app_c1, app_c2)
from .api import (get_health, port_dlg, port_ap, port_client_base)
import multiprocessing as mp import multiprocessing as mp
port = port_dlg
host = host from config import host, port_ap, port_client_base, port_dlg
# server from emulate_fastapi import app_ap, app_c1, app_c2, app_dlg, get_health
app_ports = [
(app_dlg, port_dlg),
(app_ap, port_ap),
(app_c1, port_client_base),
(app_c2, port_client_base + 1),
]
urls = list()
# start servers as processes (dlg, ap, c1 and c2 for tests)
for app, port in app_ports:
breakpoint()
proc = mp.Process( proc = mp.Process(
target=uvicorn.run, target=uvicorn.run,
args=(app_dlg,), args=(app,),
kwargs={"host": host, "port": port, "log_level": "info"}, kwargs={"host": host, "port": port, "log_level": "info"},
daemon=True, daemon=True,
) )
proc.start() proc.start()
urls.append(f"http://{host}:{port}")
url = f"http://{host}:{port}" # check server health
for url in urls:
res = get_health(url=url + "/health") res = get_health(url=url + "/health")
if res is None: if res is None:
raise Exception(f"Couldn't reach {url} after starting server") raise Exception(f"Couldn't reach {url} after starting server")

5
pkgs/clan-cli/clan_cli/webui/sql_models.py
View File

@@ -1,4 +1,4 @@
from sqlalchemy import JSON, Boolean, Column, ForeignKey, Integer, String, Text, Enum from sqlalchemy import JSON, Boolean, Column, Enum, ForeignKey, Integer, String, Text
from sqlalchemy.orm import relationship from sqlalchemy.orm import relationship
from .schemas import Roles from .schemas import Roles
@@ -16,7 +16,8 @@ class Entity(Base):
name = Column(String, index=True, unique=True) name = Column(String, index=True, unique=True)
ip = Column(String, index=True) ip = Column(String, index=True)
network = Column(String, index=True) network = Column(String, index=True)
role = Column(Enum(Roles), index=True) role = Column(Enum(Roles), index=True, nullable=False) # type: ignore
# role = Column(String, index=True, nullable=False)
attached = Column(Boolean, index=True) attached = Column(Boolean, index=True)
visible = Column(Boolean, index=True) visible = Column(Boolean, index=True)
stop_health_task = Column(Boolean) stop_health_task = Column(Boolean)

4
pkgs/clan-cli/config.py Normal file
View File

@@ -0,0 +1,4 @@
host = "127.0.0.1"
port_dlg = 6000
port_ap = 6600
port_client_base = 7000

205
pkgs/clan-cli/emulate_fastapi.py Normal file
View File

@@ -0,0 +1,205 @@
import sys
import time
import urllib
from fastapi import FastAPI
from fastapi.responses import HTMLResponse
app_dlg = FastAPI()
app_ap = FastAPI()
app_c1 = FastAPI()
app_c2 = FastAPI()
# bash tests: curl localhost:6600/ap_list_of_services
# curl localhost:7001/consume_service_from_other_entity
#### HEALTH
@app_c1.get("/health")
async def healthcheck_c1() -> str:
return "200 OK"
@app_c2.get("/health")
async def healthcheck_c2() -> str:
return "200 OK"
@app_dlg.get("/health")
async def healthcheck_dlg() -> str:
return "200 OK"
@app_ap.get("/health")
async def healthcheck_ap() -> str:
return "200 OK"
def get_health(*, url: str, max_retries: int = 20, delay: float = 0.2) -> str | None:
for attempt in range(max_retries):
try:
with urllib.request.urlopen(url) as response:
return response.read()
except urllib.error.URLError as e:
print(f"Attempt {attempt + 1} failed: {e.reason}", file=sys.stderr)
time.sleep(delay)
return None
#### CONSUME SERVICE
# TODO send_msg???
@app_c1.get("/consume_service_from_other_entity", response_class=HTMLResponse)
async def consume_service_from_other_entity_c1() -> HTMLResponse:
html_content = """
<html>
<body>
<div style="width:480px"><iframe allow="fullscreen" frameBorder="0" height="270" src="https://giphy.com/embed/IOWD3uknMxYyh7CsgN/video" width="480"></iframe></div>
</body>
</html>
"""
time.sleep(3)
return HTMLResponse(content=html_content, status_code=200)
@app_c2.get("/consume_service_from_other_entity", response_class=HTMLResponse)
async def consume_service_from_other_entity_c2() -> HTMLResponse:
html_content = """
<html>
<body>
<div style="width:480px"><iframe allow="fullscreen" frameBorder="0" height="270" src="https://giphy.com/embed/IOWD3uknMxYyh7CsgN/video" width="480"></iframe></div>
</body>
</html>
"""
time.sleep(3)
return HTMLResponse(content=html_content, status_code=200)
#### ap_list_of_services
@app_ap.get("/ap_list_of_services", response_class=HTMLResponse)
async def ap_list_of_services() -> HTMLResponse:
html_content = b"""HTTP/1.1 200 OK\r\n\r\n[[
{
"uuid": "8e285c0c-4e40-430a-a477-26b3b81e30df",
"service_name": "Carlos Printing",
"service_type": "3D Printing",
"endpoint_url": "http://127.0.0.1:8000",
"status": "unknown",
"other": {
"action": [
"register",
"deregister",
"delete",
"create"
]
},
"entity_did": "did:sov:test:1234"
},
{
"uuid": "8e285c0c-4e40-430a-a477-26b3b81e30d1",
"service_name": "Luiss Fax",
"service_type": "Fax",
"endpoint_url": "http://127.0.0.1:8000",
"status": "unknown",
"other": {
"action": [
"register",
"deregister",
"delete",
"create"
]
},
"entity_did": "did:sov:test:1235"
},
{
"uuid": "8e285c0c-4e40-430a-a477-26b3b81e30d2",
"service_name": "Erdems VR-Stream",
"service_type": "VR-Stream",
"endpoint_url": "http://127.0.0.1:8000",
"status": "unknown",
"other": {
"action": [
"register",
"deregister",
"delete",
"create"
]
},
"entity_did": "did:sov:test:1236"
},
{
"uuid": "8e285c0c-4e40-430a-a477-26b3b81e30d3",
"service_name": "Onurs gallary",
"service_type": "gallary",
"endpoint_url": "http://127.0.0.1:8000",
"status": "unknown",
"other": {
"action": [
"register",
"deregister",
"delete",
"create"
]
},
"entity_did": "did:sov:test:1237"
},
{
"uuid": "8e285c0c-4e40-430a-a477-26b3b81e30d4",
"service_name": "Saras Game-Shop",
"service_type": "Game-Shop",
"endpoint_url": "http://127.0.0.1:8000",
"status": "unknown",
"other": {
"action": [
"register",
"deregister",
"delete",
"create"
]
},
"entity_did": "did:sov:test:1238"
}
]]"""
return HTMLResponse(content=html_content, status_code=200)
@app_dlg.get("/dlg_list_of_did_resolutions", response_class=HTMLResponse)
async def dlg_list_of_did_resolutions() -> HTMLResponse:
html_content = b"""HTTP/1.1 200 OK\r\n\r\n
[
{
"did": "did:sov:test:1234",
"name": "C1",
"ip": "127.0.0.1:5100",
"attached": false,
"visible": true,
"other": {
"network": "Carlo1's Home Network",
"roles": [
"service repository",
"service consumer"
]
}
},
{
"did": "did:sov:test:1235",
"name": "C2",
"ip": "127.0.0.1:5100",
"attached": false,
"visible": true,
"other": {
"network": "Carlo2's Home Network",
"roles": [
"service repository",
"service prosumer"
]
}
}
]"""
return HTMLResponse(content=html_content, status_code=200)

96
pkgs/clan-cli/tests/api.py
View File

@@ -11,10 +11,8 @@ from fastapi.testclient import TestClient
from openapi_client import ApiClient, Configuration from openapi_client import ApiClient, Configuration
from ports import PortFunction from ports import PortFunction
from clan_cli.webui.app import app
import emulate_fastapi
import config import config
from clan_cli.webui.app import app
@pytest.fixture(scope="session") @pytest.fixture(scope="session")
@@ -55,98 +53,6 @@ def server_url(unused_tcp_port: PortFunction) -> Generator[str, None, None]:
yield url yield url
proc.terminate() proc.terminate()
# Pytest fixture to run the server in a separate process
# emulating c1
@pytest.fixture(scope="session")
def server_c1() -> Generator[str, None, None]:
port = port_client_base
host = host
# server
proc = Process(
target=uvicorn.run,
args=(app,),
kwargs={"host": host, "port": port, "log_level": "info"},
daemon=True,
)
proc.start()
url = f"http://{host}:{port}"
res = get_health(url=url + "/health")
if res is None:
raise Exception(f"Couldn't reach {url} after starting server")
yield url
proc.terminate()
# Pytest fixture to run the server in a separate process
# emulating c2
@pytest.fixture(scope="session")
def server_c2() -> Generator[str, None, None]:
port = port_client_base+1
host = host
# server
proc = Process(
target=uvicorn.run,
args=(app,),
kwargs={"host": host, "port": port, "log_level": "info"},
daemon=True,
)
proc.start()
url = f"http://{host}:{port}"
res = get_health(url=url + "/health")
if res is None:
raise Exception(f"Couldn't reach {url} after starting server")
yield url
proc.terminate()
proc.terminate()
# Pytest fixture to run the server in a separate process
# emulating ap
@pytest.fixture(scope="session")
def server_ap() -> Generator[str, None, None]:
port = port_ap
host = host
# server
proc = Process(
target=uvicorn.run,
args=(app,),
kwargs={"host": host, "port": port, "log_level": "info"},
daemon=True,
)
proc.start()
url = f"http://{host}:{port}"
res = get_health(url=url + "/health")
if res is None:
raise Exception(f"Couldn't reach {url} after starting server")
yield url
proc.terminate()
# Pytest fixture to run the server in a separate process
# emulating dlg
@pytest.fixture(scope="session")
def server_dlg() -> Generator[str, None, None]:
port = port_dlg
host = host
# server
proc = Process(
target=uvicorn.run,
args=(app,),
kwargs={"host": host, "port": port, "log_level": "info"},
daemon=True,
)
proc.start()
url = f"http://{host}:{port}"
res = get_health(url=url + "/health")
if res is None:
raise Exception(f"Couldn't reach {url} after starting server")
yield url
proc.terminate()
@pytest.fixture(scope="session") @pytest.fixture(scope="session")
def api_client(server_url: str) -> Generator[ApiClient, None, None]: def api_client(server_url: str) -> Generator[ApiClient, None, None]:

48
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
@@ -61,13 +60,15 @@ No authorization required
- **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
@@ -122,13 +122,15 @@ No authorization required
- **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
@@ -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
@@ -184,10 +184,10 @@ No authorization required
- **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 | - |
**422** | Validation Error | - | | **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)

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

@@ -1,21 +1,21 @@
# 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
[**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 |
| [**is_attached**](EntitiesApi.md#is_attached) | **GET** /api/v1/is_attached | Is Attached |
# **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
@@ -53,15 +53,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 &#39;did:sov:test:1234&#39;] | **entity_did** | **str** | | [optional] [default to &#39;did:sov:test:1234&#39;] |
**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
@@ -77,14 +75,16 @@ No authorization required
- **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 | - |
**422** | Validation Error | - | | **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
@@ -122,13 +122,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
@@ -144,14 +142,16 @@ No authorization required
- **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 | - |
**422** | Validation Error | - | | **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
@@ -187,13 +187,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 &#39;did:sov:test:1234&#39;] | **entity_did** | **str** | | [optional] [default to &#39;did:sov:test:1234&#39;] |
### Return type ### Return type
@@ -209,14 +207,16 @@ No authorization required
- **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 | - |
**422** | Validation Error | - | | **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**
> Dict[str, str] 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 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 &#39;did:sov:test:1234&#39;] | **entity_did** | **str** | | [optional] [default to &#39;did:sov:test:1234&#39;] |
**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
@@ -278,14 +276,16 @@ No authorization required
- **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 | - |
**422** | Validation Error | - | | **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
@@ -346,14 +344,16 @@ No authorization required
- **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 | - |
**422** | Validation Error | - | | **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
@@ -414,14 +412,16 @@ No authorization required
- **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 | - |
**422** | Validation Error | - | | **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 &#39;did:sov:test:1234&#39;] | **entity_did** | **str** | | [optional] [default to &#39;did:sov:test:1234&#39;] |
### Return type ### Return type
@@ -480,14 +478,16 @@ No authorization required
- **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 | - |
**422** | Validation Error | - | | **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
@@ -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
@@ -546,14 +544,16 @@ No authorization required
- **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 | - |
**422** | Validation Error | - | | **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)
# **is_attached** # **is_attached**
> Dict[str, str] is_attached(entity_did=entity_did) > Dict[str, str] is_attached(entity_did=entity_did)
Is Attached Is Attached
@@ -589,13 +589,11 @@ with openapi_client.ApiClient(configuration) as api_client:
print("Exception when calling EntitiesApi->is_attached: %s\n" % e) print("Exception when calling EntitiesApi->is_attached: %s\n" % e)
``` ```
### Parameters ### Parameters
Name | Type | Description | Notes | Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- | -------------- | ------- | ----------- | --------------------------------------------------- |
**entity_did** | **str**| | [optional] [default to &#39;did:sov:test:1234&#39;] | **entity_did** | **str** | | [optional] [default to &#39;did:sov:test:1234&#39;] |
### Return type ### Return type
@@ -611,10 +609,10 @@ No authorization required
- **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 | - |
**422** | Validation Error | - | | **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)

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

@@ -1,18 +1,18 @@
# Entity # Entity
## Properties ## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- | Name | Type | Description | Notes |
**did** | **str** | | | -------------------- | --------------------- | ----------- | ----- |
**name** | **str** | | | **did** | **str** | |
**ip** | **str** | | | **name** | **str** | |
**network** | **str** | | | **ip** | **str** | |
**role** | [**Roles**](Roles.md) | | | **network** | **str** | |
**visible** | **bool** | | | **role** | [**Roles**](Roles.md) | |
**other** | **object** | | | **visible** | **bool** | |
**attached** | **bool** | | | **other** | **object** | |
**stop_health_task** | **bool** | | | **attached** | **bool** | |
| **stop_health_task** | **bool** | |
## Example ## Example
@@ -31,6 +31,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)

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

@@ -1,16 +1,16 @@
# EntityCreate # EntityCreate
## Properties ## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- | Name | Type | Description | Notes |
**did** | **str** | | | ----------- | --------------------- | ----------- | ----- |
**name** | **str** | | | **did** | **str** | |
**ip** | **str** | | | **name** | **str** | |
**network** | **str** | | | **ip** | **str** | |
**role** | [**Roles**](Roles.md) | | | **network** | **str** | |
**visible** | **bool** | | | **role** | [**Roles**](Roles.md) | |
**other** | **object** | | | **visible** | **bool** | |
| **other** | **object** | |
## Example ## Example
@@ -29,6 +29,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)

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

@@ -1,17 +1,17 @@
# Eventmessage # Eventmessage
## Properties ## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- | Name | Type | Description | Notes |
**id** | **int** | | | ------------- | ---------- | ----------- | ----- |
**timestamp** | **int** | | | **id** | **int** | |
**group** | **int** | | | **timestamp** | **int** | |
**group_id** | **int** | | | **group** | **int** | |
**msg_type** | **int** | | | **group_id** | **int** | |
**src_did** | **str** | | | **msg_type** | **int** | |
**des_did** | **str** | | | **src_did** | **str** | |
**msg** | **object** | | | **des_did** | **str** | |
| **msg** | **object** | |
## Example ## Example
@@ -30,6 +30,5 @@ eventmessage_dict = eventmessage_instance.to_dict()
# create an instance of Eventmessage from a dict # create an instance of Eventmessage from a dict
eventmessage_form_dict = eventmessage.from_dict(eventmessage_dict) eventmessage_form_dict = eventmessage.from_dict(eventmessage_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)

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

@@ -1,17 +1,17 @@
# EventmessageCreate # EventmessageCreate
## Properties ## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- | Name | Type | Description | Notes |
**id** | **int** | | | ------------- | ---------- | ----------- | ----- |
**timestamp** | **int** | | | **id** | **int** | |
**group** | **int** | | | **timestamp** | **int** | |
**group_id** | **int** | | | **group** | **int** | |
**msg_type** | **int** | | | **group_id** | **int** | |
**src_did** | **str** | | | **msg_type** | **int** | |
**des_did** | **str** | | | **src_did** | **str** | |
**msg** | **object** | | | **des_did** | **str** | |
| **msg** | **object** | |
## Example ## Example
@@ -30,6 +30,5 @@ eventmessage_create_dict = eventmessage_create_instance.to_dict()
# create an instance of EventmessageCreate from a dict # create an instance of EventmessageCreate from a dict
eventmessage_create_form_dict = eventmessage_create.from_dict(eventmessage_create_dict) eventmessage_create_form_dict = eventmessage_create.from_dict(eventmessage_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)

46
pkgs/clan-cli/tests/openapi_client/docs/EventmessagesApi.md
View File

@@ -1,14 +1,14 @@
# openapi_client.EventmessagesApi # openapi_client.EventmessagesApi
All URIs are relative to *http://localhost* All URIs are relative to _http://localhost_
Method | HTTP request | Description
------------- | ------------- | -------------
[**create_eventmessage**](EventmessagesApi.md#create_eventmessage) | **POST** /api/v1/send_msg | Create Eventmessage
[**get_all_eventmessages**](EventmessagesApi.md#get_all_eventmessages) | **GET** /api/v1/event_messages | Get All Eventmessages
| Method | HTTP request | Description |
| ---------------------------------------------------------------------- | ------------------------------ | --------------------- |
| [**create_eventmessage**](EventmessagesApi.md#create_eventmessage) | **POST** /api/v1/send_msg | Create Eventmessage |
| [**get_all_eventmessages**](EventmessagesApi.md#get_all_eventmessages) | **GET** /api/v1/event_messages | Get All Eventmessages |
# **create_eventmessage** # **create_eventmessage**
> Eventmessage create_eventmessage(eventmessage_create) > Eventmessage create_eventmessage(eventmessage_create)
Create Eventmessage Create Eventmessage
@@ -46,13 +46,11 @@ with openapi_client.ApiClient(configuration) as api_client:
print("Exception when calling EventmessagesApi->create_eventmessage: %s\n" % e) print("Exception when calling EventmessagesApi->create_eventmessage: %s\n" % e)
``` ```
### Parameters ### Parameters
Name | Type | Description | Notes | Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- | ----------------------- | ----------------------------------------------- | ----------- | ----- |
**eventmessage_create** | [**EventmessageCreate**](EventmessageCreate.md)| | | **eventmessage_create** | [**EventmessageCreate**](EventmessageCreate.md) | |
### Return type ### Return type
@@ -68,14 +66,16 @@ No authorization required
- **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 | - |
**422** | Validation Error | - | | **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_eventmessages** # **get_all_eventmessages**
> List[Eventmessage] get_all_eventmessages(skip=skip, limit=limit) > List[Eventmessage] get_all_eventmessages(skip=skip, limit=limit)
Get All Eventmessages Get All Eventmessages
@@ -113,14 +113,12 @@ with openapi_client.ApiClient(configuration) as api_client:
print("Exception when calling EventmessagesApi->get_all_eventmessages: %s\n" % e) print("Exception when calling EventmessagesApi->get_all_eventmessages: %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
@@ -136,10 +134,10 @@ No authorization required
- **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 | - |
**422** | Validation Error | - | | **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)

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)

28
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
@@ -68,10 +66,10 @@ No authorization required
- **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 | - |
**422** | Validation Error | - | | **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)

28
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
@@ -68,10 +66,10 @@ No authorization required
- **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 | - |
**422** | Validation Error | - | | **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)

10
pkgs/clan-cli/tests/openapi_client/docs/Roles.md Normal file
View File

@@ -0,0 +1,10 @@
# Roles
An enumeration.
## Properties
| 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)

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)

108
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
@@ -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
@@ -71,14 +69,16 @@ No authorization required
- **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 | - |
**422** | Validation Error | - | | **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 &#39;did:sov:test:1234&#39;] | **entity_did** | **str** | | [optional] [default to &#39;did:sov:test:1234&#39;] |
### Return type ### Return type
@@ -136,14 +134,16 @@ No authorization required
- **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 | - |
**422** | Validation Error | - | | **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
@@ -204,14 +202,16 @@ No authorization required
- **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 | - |
**422** | Validation Error | - | | **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 &#39;did:sov:test:1234&#39;] | **entity_did** | **str** | | [optional] [default to &#39;did:sov:test:1234&#39;] |
**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,14 +272,16 @@ No authorization required
- **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 | - |
**422** | Validation Error | - | | **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 &#39;did:sov:test:1234&#39;] | **entity_did** | **str** | | [optional] [default to &#39;did:sov:test:1234&#39;] |
**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
@@ -344,10 +342,10 @@ No authorization required
- **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 | - |
**422** | Validation Error | - | | **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)

41
pkgs/clan-cli/tests/openapi_client/models/roles.py Normal file
View File

@@ -0,0 +1,41 @@
# coding: utf-8
"""
FastAPI
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
The version of the OpenAPI document: 0.1.0
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
""" # noqa: E501
import json
import pprint
import re # noqa: F401
from aenum import Enum, no_arg
class Roles(str, Enum):
"""
An enumeration.
"""
"""
allowed enum values
"""
SERVICE_PROSUMER = 'service_prosumer'
AP = 'AP'
DLG = 'DLG'
@classmethod
def from_json(cls, json_str: str) -> Roles:
"""Create an instance of Roles from a JSON string"""
return Roles(json.loads(json_str))

25
pkgs/clan-cli/tests/test_db_api.py
View File

@@ -1,7 +1,6 @@
import random import random
import time import time
import uuid import uuid
import api
from openapi_client import ApiClient from openapi_client import ApiClient
from openapi_client.api import DefaultApi from openapi_client.api import DefaultApi
@@ -14,18 +13,20 @@ from openapi_client.models import (
Eventmessage, Eventmessage,
EventmessageCreate, EventmessageCreate,
Machine, Machine,
Roles,
ServiceCreate, ServiceCreate,
Status, Status,
Roles,
) )
import config
random.seed(42) random.seed(42)
#is linked to the emulate_fastapi.py and api.py
host = api.host host = config.host
port_dlg = api.port_dlg port_dlg = config.port_dlg
port_ap = api.port_ap port_ap = config.port_ap
port_client_base = api.port_client_base port_client_base = config.port_client_base
num_uuids = 100 num_uuids = 100
uuids = [str(uuid.UUID(int=random.getrandbits(128))) for i in range(num_uuids)] uuids = [str(uuid.UUID(int=random.getrandbits(128))) for i in range(num_uuids)]
@@ -44,7 +45,7 @@ def create_entities(num: int = 10) -> list[EntityCreate]:
did=f"did:sov:test:12{i}", did=f"did:sov:test:12{i}",
name=f"C{i}", name=f"C{i}",
ip=f"{host}:{port_client_base+i}", ip=f"{host}:{port_client_base+i}",
network=f"255.255.0.0", network="255.255.0.0",
role=Roles("service_prosumer"), role=Roles("service_prosumer"),
visible=True, visible=True,
other={}, other={},
@@ -52,9 +53,9 @@ def create_entities(num: int = 10) -> list[EntityCreate]:
res.append(en) res.append(en)
dlg = EntityCreate( dlg = EntityCreate(
did=f"did:sov:test:{port_dlg}", did=f"did:sov:test:{port_dlg}",
name=f"DLG", name="DLG",
ip=f"{host}:{port_dlg}/health", ip=f"{host}:{port_dlg}/health",
network=f"255.255.0.0", network="255.255.0.0",
role=Roles("DLG"), role=Roles("DLG"),
visible=True, visible=True,
other={}, other={},
@@ -62,9 +63,9 @@ def create_entities(num: int = 10) -> list[EntityCreate]:
res.append(dlg) res.append(dlg)
ap = EntityCreate( ap = EntityCreate(
did=f"did:sov:test:{port_ap}", did=f"did:sov:test:{port_ap}",
name=f"AP", name="AP",
ip=f"{host}:{port_ap}/health", ip=f"{host}:{port_ap}/health",
network=f"255.255.0.0", network="255.255.0.0",
role=Roles("AP"), role=Roles("AP"),
visible=True, visible=True,
other={}, other={},