generated from Luis/nextjs-python-web-template
add event msg with populate and the right table in swagger
This commit is contained in:
Georg-Stahn
34
pkgs/clan-cli/tests/openapi_client/docs/Eventmessage.md
Normal file
34
pkgs/clan-cli/tests/openapi_client/docs/Eventmessage.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# Eventmessage
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ------------- | ---------- | ----------- | ----- |
|
||||
| **id** | **int** | |
|
||||
| **timestamp** | **int** | |
|
||||
| **group** | **int** | |
|
||||
| **group_id** | **int** | |
|
||||
| **msg_type** | **int** | |
|
||||
| **src_did** | **str** | |
|
||||
| **des_did** | **str** | |
|
||||
| **msg** | **object** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from openapi_client.models.eventmessage import Eventmessage
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of Eventmessage from a JSON string
|
||||
eventmessage_instance = Eventmessage.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print Eventmessage.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
eventmessage_dict = eventmessage_instance.to_dict()
|
||||
# create an instance of Eventmessage from a 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)
|
||||
@@ -0,0 +1,34 @@
|
||||
# EventmessageCreate
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ------------- | ---------- | ----------- | ----- |
|
||||
| **id** | **int** | |
|
||||
| **timestamp** | **int** | |
|
||||
| **group** | **int** | |
|
||||
| **group_id** | **int** | |
|
||||
| **msg_type** | **int** | |
|
||||
| **src_did** | **str** | |
|
||||
| **des_did** | **str** | |
|
||||
| **msg** | **object** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from openapi_client.models.eventmessage_create import EventmessageCreate
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of EventmessageCreate from a JSON string
|
||||
eventmessage_create_instance = EventmessageCreate.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print EventmessageCreate.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
eventmessage_create_dict = eventmessage_create_instance.to_dict()
|
||||
# create an instance of EventmessageCreate from a 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)
|
||||
143
pkgs/clan-cli/tests/openapi_client/docs/EventmessagesApi.md
Normal file
143
pkgs/clan-cli/tests/openapi_client/docs/EventmessagesApi.md
Normal file
@@ -0,0 +1,143 @@
|
||||
# openapi_client.EventmessagesApi
|
||||
|
||||
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 |
|
||||
|
||||
# **create_eventmessage**
|
||||
|
||||
> Eventmessage create_eventmessage(eventmessage_create)
|
||||
|
||||
Create Eventmessage
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
import time
|
||||
import os
|
||||
import openapi_client
|
||||
from openapi_client.models.eventmessage import Eventmessage
|
||||
from openapi_client.models.eventmessage_create import EventmessageCreate
|
||||
from openapi_client.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# Defining the host is optional and defaults to http://localhost
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client.Configuration(
|
||||
host = "http://localhost"
|
||||
)
|
||||
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client.EventmessagesApi(api_client)
|
||||
eventmessage_create = openapi_client.EventmessageCreate() # EventmessageCreate |
|
||||
|
||||
try:
|
||||
# Create Eventmessage
|
||||
api_response = api_instance.create_eventmessage(eventmessage_create)
|
||||
print("The response of EventmessagesApi->create_eventmessage:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling EventmessagesApi->create_eventmessage: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| ----------------------- | ----------------------------------------------- | ----------- | ----- |
|
||||
| **eventmessage_create** | [**EventmessageCreate**](EventmessageCreate.md) | |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Eventmessage**](Eventmessage.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | ------------------- | ---------------- |
|
||||
| **200** | Successful Response | - |
|
||||
| **422** | Validation Error | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **get_all_eventmessages**
|
||||
|
||||
> List[Eventmessage] get_all_eventmessages(skip=skip, limit=limit)
|
||||
|
||||
Get All Eventmessages
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
import time
|
||||
import os
|
||||
import openapi_client
|
||||
from openapi_client.models.eventmessage import Eventmessage
|
||||
from openapi_client.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# Defining the host is optional and defaults to http://localhost
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client.Configuration(
|
||||
host = "http://localhost"
|
||||
)
|
||||
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client.EventmessagesApi(api_client)
|
||||
skip = 0 # int | (optional) (default to 0)
|
||||
limit = 100 # int | (optional) (default to 100)
|
||||
|
||||
try:
|
||||
# Get All Eventmessages
|
||||
api_response = api_instance.get_all_eventmessages(skip=skip, limit=limit)
|
||||
print("The response of EventmessagesApi->get_all_eventmessages:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling EventmessagesApi->get_all_eventmessages: %s\n" % e)
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Name | Type | Description | Notes |
|
||||
| --------- | ------- | ----------- | --------------------------- |
|
||||
| **skip** | **int** | | [optional] [default to 0] |
|
||||
| **limit** | **int** | | [optional] [default to 100] |
|
||||
|
||||
### Return type
|
||||
|
||||
[**List[Eventmessage]**](Eventmessage.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
| ----------- | ------------------- | ---------------- |
|
||||
| **200** | Successful Response | - |
|
||||
| **422** | Validation Error | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
Reference in New Issue
Block a user