add: demo server and client
This commit is contained in:
Charles
29
demo_server/demo_client/docs/ClaimIceCandidatesResponse.md
Normal file
29
demo_server/demo_client/docs/ClaimIceCandidatesResponse.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# ClaimIceCandidatesResponse
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**ice_candidates** | [**List[IceCandidate]**](IceCandidate.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from openapi_client.models.claim_ice_candidates_response import ClaimIceCandidatesResponse
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ClaimIceCandidatesResponse from a JSON string
|
||||
claim_ice_candidates_response_instance = ClaimIceCandidatesResponse.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(ClaimIceCandidatesResponse.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
claim_ice_candidates_response_dict = claim_ice_candidates_response_instance.to_dict()
|
||||
# create an instance of ClaimIceCandidatesResponse from a dict
|
||||
claim_ice_candidates_response_form_dict = claim_ice_candidates_response.from_dict(claim_ice_candidates_response_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)
|
||||
|
||||
|
||||
30
demo_server/demo_client/docs/GoogleProtobufAny.md
Normal file
30
demo_server/demo_client/docs/GoogleProtobufAny.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# GoogleProtobufAny
|
||||
|
||||
Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**type** | **str** | The type of the serialized message. | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from openapi_client.models.google_protobuf_any import GoogleProtobufAny
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of GoogleProtobufAny from a JSON string
|
||||
google_protobuf_any_instance = GoogleProtobufAny.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(GoogleProtobufAny.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
google_protobuf_any_dict = google_protobuf_any_instance.to_dict()
|
||||
# create an instance of GoogleProtobufAny from a dict
|
||||
google_protobuf_any_form_dict = google_protobuf_any.from_dict(google_protobuf_any_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)
|
||||
|
||||
|
||||
33
demo_server/demo_client/docs/IceCandidate.md
Normal file
33
demo_server/demo_client/docs/IceCandidate.md
Normal file
@@ -0,0 +1,33 @@
|
||||
# IceCandidate
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **str** | | [optional]
|
||||
**candidate** | **str** | | [optional]
|
||||
**sdp_mid** | **str** | | [optional]
|
||||
**sdp_line_index** | **int** | | [optional]
|
||||
**username_fragment** | **str** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from openapi_client.models.ice_candidate import IceCandidate
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of IceCandidate from a JSON string
|
||||
ice_candidate_instance = IceCandidate.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(IceCandidate.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
ice_candidate_dict = ice_candidate_instance.to_dict()
|
||||
# create an instance of IceCandidate from a dict
|
||||
ice_candidate_form_dict = ice_candidate.from_dict(ice_candidate_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
31
demo_server/demo_client/docs/IceSessionDescription.md
Normal file
31
demo_server/demo_client/docs/IceSessionDescription.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# IceSessionDescription
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **str** | A unique identifier which can be used to send ICE candidates Maps to the session name | [optional]
|
||||
**sdp_type** | **str** | Used to construct the remote description in WebRTC | [optional]
|
||||
**sdp** | **str** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from openapi_client.models.ice_session_description import IceSessionDescription
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of IceSessionDescription from a JSON string
|
||||
ice_session_description_instance = IceSessionDescription.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(IceSessionDescription.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
ice_session_description_dict = ice_session_description_instance.to_dict()
|
||||
# create an instance of IceSessionDescription from a dict
|
||||
ice_session_description_form_dict = ice_session_description.from_dict(ice_session_description_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
31
demo_server/demo_client/docs/Knock.md
Normal file
31
demo_server/demo_client/docs/Knock.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# Knock
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **str** | | [optional]
|
||||
**offer** | [**IceSessionDescription**](IceSessionDescription.md) | The service being connected too | [optional]
|
||||
**answer** | [**IceSessionDescription**](IceSessionDescription.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from openapi_client.models.knock import Knock
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of Knock from a JSON string
|
||||
knock_instance = Knock.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(Knock.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
knock_dict = knock_instance.to_dict()
|
||||
# create an instance of Knock from a dict
|
||||
knock_form_dict = knock.from_dict(knock_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)
|
||||
|
||||
|
||||
29
demo_server/demo_client/docs/ListKnocksResponse.md
Normal file
29
demo_server/demo_client/docs/ListKnocksResponse.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# ListKnocksResponse
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**knocks** | [**List[Knock]**](Knock.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from openapi_client.models.list_knocks_response import ListKnocksResponse
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ListKnocksResponse from a JSON string
|
||||
list_knocks_response_instance = ListKnocksResponse.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(ListKnocksResponse.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
list_knocks_response_dict = list_knocks_response_instance.to_dict()
|
||||
# create an instance of ListKnocksResponse from a dict
|
||||
list_knocks_response_form_dict = list_knocks_response.from_dict(list_knocks_response_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)
|
||||
|
||||
|
||||
765
demo_server/demo_client/docs/PeerNetServiceApi.md
Normal file
765
demo_server/demo_client/docs/PeerNetServiceApi.md
Normal file
@@ -0,0 +1,765 @@
|
||||
# openapi_client.PeerNetServiceApi
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**peer_net_service_claim_ice_candidates**](PeerNetServiceApi.md#peer_net_service_claim_ice_candidates) | **GET** /v1/sessions/{session}/claim/candidates |
|
||||
[**peer_net_service_create_ice_candidate**](PeerNetServiceApi.md#peer_net_service_create_ice_candidate) | **POST** /v1/sessions/{session}/candidates |
|
||||
[**peer_net_service_create_knock**](PeerNetServiceApi.md#peer_net_service_create_knock) | **POST** /v1/servers/{server}/services/{service}/knocks |
|
||||
[**peer_net_service_create_server**](PeerNetServiceApi.md#peer_net_service_create_server) | **POST** /v1/servers |
|
||||
[**peer_net_service_create_service**](PeerNetServiceApi.md#peer_net_service_create_service) | **POST** /v1/servers/{server}/services |
|
||||
[**peer_net_service_delete_server**](PeerNetServiceApi.md#peer_net_service_delete_server) | **DELETE** /v1/servers/* |
|
||||
[**peer_net_service_delete_service**](PeerNetServiceApi.md#peer_net_service_delete_service) | **DELETE** /v1/servers/{server}/services/{service} |
|
||||
[**peer_net_service_get_knock**](PeerNetServiceApi.md#peer_net_service_get_knock) | **GET** /v1/servers/{server}/services/{service}/knocks/{knock} |
|
||||
[**peer_net_service_get_room**](PeerNetServiceApi.md#peer_net_service_get_room) | **GET** /v1/rooms/{room} |
|
||||
[**peer_net_service_list_knocks**](PeerNetServiceApi.md#peer_net_service_list_knocks) | **GET** /v1/servers/{server}/services/{service}/knocks |
|
||||
[**peer_net_service_update_knock**](PeerNetServiceApi.md#peer_net_service_update_knock) | **PATCH** /v1/servers/{server}/services/{service}/knocks/{knock} |
|
||||
|
||||
|
||||
# **peer_net_service_claim_ice_candidates**
|
||||
> ClaimIceCandidatesResponse peer_net_service_claim_ice_candidates(session)
|
||||
|
||||
|
||||
|
||||
Acts as both List and Delete atomically.
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import openapi_client
|
||||
from openapi_client.models.claim_ice_candidates_response import ClaimIceCandidatesResponse
|
||||
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.PeerNetServiceApi(api_client)
|
||||
session = 'session_example' # str | The session id.
|
||||
|
||||
try:
|
||||
api_response = api_instance.peer_net_service_claim_ice_candidates(session)
|
||||
print("The response of PeerNetServiceApi->peer_net_service_claim_ice_candidates:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling PeerNetServiceApi->peer_net_service_claim_ice_candidates: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**session** | **str**| The session id. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**ClaimIceCandidatesResponse**](ClaimIceCandidatesResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**0** | Default error 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)
|
||||
|
||||
# **peer_net_service_create_ice_candidate**
|
||||
> IceCandidate peer_net_service_create_ice_candidate(session, ice_candidate)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import openapi_client
|
||||
from openapi_client.models.ice_candidate import IceCandidate
|
||||
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.PeerNetServiceApi(api_client)
|
||||
session = 'session_example' # str | The session id.
|
||||
ice_candidate = openapi_client.IceCandidate() # IceCandidate |
|
||||
|
||||
try:
|
||||
api_response = api_instance.peer_net_service_create_ice_candidate(session, ice_candidate)
|
||||
print("The response of PeerNetServiceApi->peer_net_service_create_ice_candidate:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling PeerNetServiceApi->peer_net_service_create_ice_candidate: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**session** | **str**| The session id. |
|
||||
**ice_candidate** | [**IceCandidate**](IceCandidate.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**IceCandidate**](IceCandidate.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**0** | Default error 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)
|
||||
|
||||
# **peer_net_service_create_knock**
|
||||
> Knock peer_net_service_create_knock(server, service, knock)
|
||||
|
||||
|
||||
|
||||
Creates a knock that will be answered by the peer; the signaler may delete the knock, regardless of the state, when it ages.
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import openapi_client
|
||||
from openapi_client.models.knock import Knock
|
||||
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.PeerNetServiceApi(api_client)
|
||||
server = 'server_example' # str | The server id.
|
||||
service = 'service_example' # str | The service id.
|
||||
knock = openapi_client.Knock() # Knock |
|
||||
|
||||
try:
|
||||
api_response = api_instance.peer_net_service_create_knock(server, service, knock)
|
||||
print("The response of PeerNetServiceApi->peer_net_service_create_knock:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling PeerNetServiceApi->peer_net_service_create_knock: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**server** | **str**| The server id. |
|
||||
**service** | **str**| The service id. |
|
||||
**knock** | [**Knock**](Knock.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Knock**](Knock.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**0** | Default error 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)
|
||||
|
||||
# **peer_net_service_create_server**
|
||||
> Server peer_net_service_create_server(server)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import openapi_client
|
||||
from openapi_client.models.server import Server
|
||||
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.PeerNetServiceApi(api_client)
|
||||
server = openapi_client.Server() # Server |
|
||||
|
||||
try:
|
||||
api_response = api_instance.peer_net_service_create_server(server)
|
||||
print("The response of PeerNetServiceApi->peer_net_service_create_server:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling PeerNetServiceApi->peer_net_service_create_server: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**server** | [**Server**](Server.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Server**](Server.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**0** | Default error 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)
|
||||
|
||||
# **peer_net_service_create_service**
|
||||
> Service peer_net_service_create_service(server, service)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import openapi_client
|
||||
from openapi_client.models.service import Service
|
||||
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.PeerNetServiceApi(api_client)
|
||||
server = 'server_example' # str | The server id.
|
||||
service = openapi_client.Service() # Service |
|
||||
|
||||
try:
|
||||
api_response = api_instance.peer_net_service_create_service(server, service)
|
||||
print("The response of PeerNetServiceApi->peer_net_service_create_service:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling PeerNetServiceApi->peer_net_service_create_service: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**server** | **str**| The server id. |
|
||||
**service** | [**Service**](Service.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Service**](Service.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**0** | Default error 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)
|
||||
|
||||
# **peer_net_service_delete_server**
|
||||
> peer_net_service_delete_server(name=name)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import openapi_client
|
||||
from openapi_client.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# Defining the host is optional and defaults to http://localhost
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client.Configuration(
|
||||
host = "http://localhost"
|
||||
)
|
||||
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client.PeerNetServiceApi(api_client)
|
||||
name = 'name_example' # str | (optional)
|
||||
|
||||
try:
|
||||
api_instance.peer_net_service_delete_server(name=name)
|
||||
except Exception as e:
|
||||
print("Exception when calling PeerNetServiceApi->peer_net_service_delete_server: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**name** | **str**| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**0** | Default error 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)
|
||||
|
||||
# **peer_net_service_delete_service**
|
||||
> peer_net_service_delete_service(server, service)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import openapi_client
|
||||
from openapi_client.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
# Defining the host is optional and defaults to http://localhost
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = openapi_client.Configuration(
|
||||
host = "http://localhost"
|
||||
)
|
||||
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with openapi_client.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = openapi_client.PeerNetServiceApi(api_client)
|
||||
server = 'server_example' # str | The server id.
|
||||
service = 'service_example' # str | The service id.
|
||||
|
||||
try:
|
||||
api_instance.peer_net_service_delete_service(server, service)
|
||||
except Exception as e:
|
||||
print("Exception when calling PeerNetServiceApi->peer_net_service_delete_service: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**server** | **str**| The server id. |
|
||||
**service** | **str**| The service id. |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**0** | Default error 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)
|
||||
|
||||
# **peer_net_service_get_knock**
|
||||
> Knock peer_net_service_get_knock(server, service, knock)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import openapi_client
|
||||
from openapi_client.models.knock import Knock
|
||||
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.PeerNetServiceApi(api_client)
|
||||
server = 'server_example' # str | The server id.
|
||||
service = 'service_example' # str | The service id.
|
||||
knock = 'knock_example' # str | The knock id.
|
||||
|
||||
try:
|
||||
api_response = api_instance.peer_net_service_get_knock(server, service, knock)
|
||||
print("The response of PeerNetServiceApi->peer_net_service_get_knock:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling PeerNetServiceApi->peer_net_service_get_knock: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**server** | **str**| The server id. |
|
||||
**service** | **str**| The service id. |
|
||||
**knock** | **str**| The knock id. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Knock**](Knock.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**0** | Default error 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)
|
||||
|
||||
# **peer_net_service_get_room**
|
||||
> Room peer_net_service_get_room(room)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import openapi_client
|
||||
from openapi_client.models.room import Room
|
||||
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.PeerNetServiceApi(api_client)
|
||||
room = 'room_example' # str | The room id.
|
||||
|
||||
try:
|
||||
api_response = api_instance.peer_net_service_get_room(room)
|
||||
print("The response of PeerNetServiceApi->peer_net_service_get_room:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling PeerNetServiceApi->peer_net_service_get_room: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**room** | **str**| The room id. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Room**](Room.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**0** | Default error 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)
|
||||
|
||||
# **peer_net_service_list_knocks**
|
||||
> ListKnocksResponse peer_net_service_list_knocks(server, service)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import openapi_client
|
||||
from openapi_client.models.list_knocks_response import ListKnocksResponse
|
||||
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.PeerNetServiceApi(api_client)
|
||||
server = 'server_example' # str | The server id.
|
||||
service = 'service_example' # str | The service id.
|
||||
|
||||
try:
|
||||
api_response = api_instance.peer_net_service_list_knocks(server, service)
|
||||
print("The response of PeerNetServiceApi->peer_net_service_list_knocks:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling PeerNetServiceApi->peer_net_service_list_knocks: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**server** | **str**| The server id. |
|
||||
**service** | **str**| The service id. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**ListKnocksResponse**](ListKnocksResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**0** | Default error 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)
|
||||
|
||||
# **peer_net_service_update_knock**
|
||||
> Knock peer_net_service_update_knock(server, service, knock, knock2)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
import openapi_client
|
||||
from openapi_client.models.knock import Knock
|
||||
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.PeerNetServiceApi(api_client)
|
||||
server = 'server_example' # str | The server id.
|
||||
service = 'service_example' # str | The service id.
|
||||
knock = 'knock_example' # str | The knock id.
|
||||
knock2 = openapi_client.Knock() # Knock |
|
||||
|
||||
try:
|
||||
api_response = api_instance.peer_net_service_update_knock(server, service, knock, knock2)
|
||||
print("The response of PeerNetServiceApi->peer_net_service_update_knock:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling PeerNetServiceApi->peer_net_service_update_knock: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**server** | **str**| The server id. |
|
||||
**service** | **str**| The service id. |
|
||||
**knock** | **str**| The knock id. |
|
||||
**knock2** | [**Knock**](Knock.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Knock**](Knock.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
**0** | Default error 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)
|
||||
|
||||
31
demo_server/demo_client/docs/Room.md
Normal file
31
demo_server/demo_client/docs/Room.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# Room
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **str** | | [optional]
|
||||
**display_name** | **str** | | [optional]
|
||||
**servers** | [**List[Server]**](Server.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from openapi_client.models.room import Room
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of Room from a JSON string
|
||||
room_instance = Room.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(Room.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
room_dict = room_instance.to_dict()
|
||||
# create an instance of Room from a dict
|
||||
room_form_dict = room.from_dict(room_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)
|
||||
|
||||
|
||||
33
demo_server/demo_client/docs/Server.md
Normal file
33
demo_server/demo_client/docs/Server.md
Normal file
@@ -0,0 +1,33 @@
|
||||
# Server
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **str** | | [optional]
|
||||
**rooms** | **List[str]** | Tracks which rooms the server should be listed in; this will not be set when a room is listed to preserve privacy of servers. | [optional]
|
||||
**auth_token** | **str** | Used to authenticate requests which access knocks for this server or attempt to update, delete or create services. In future calls, add a header with the format: Authorization: Bearer <auth_token> | [optional]
|
||||
**display_name** | **str** | | [optional]
|
||||
**services** | [**List[Service]**](Service.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from openapi_client.models.server import Server
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of Server from a JSON string
|
||||
server_instance = Server.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(Server.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
server_dict = server_instance.to_dict()
|
||||
# create an instance of Server from a dict
|
||||
server_form_dict = server.from_dict(server_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
31
demo_server/demo_client/docs/Service.md
Normal file
31
demo_server/demo_client/docs/Service.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# Service
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **str** | | [optional]
|
||||
**protocol** | **str** | | [optional]
|
||||
**version** | **str** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from openapi_client.models.service import Service
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of Service from a JSON string
|
||||
service_instance = Service.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(Service.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
service_dict = service_instance.to_dict()
|
||||
# create an instance of Service from a dict
|
||||
service_form_dict = service.from_dict(service_dict)
|
||||
```
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
32
demo_server/demo_client/docs/Status.md
Normal file
32
demo_server/demo_client/docs/Status.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# Status
|
||||
|
||||
The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**code** | **int** | The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. | [optional]
|
||||
**message** | **str** | A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. | [optional]
|
||||
**details** | [**List[GoogleProtobufAny]**](GoogleProtobufAny.md) | A list of messages that carry the error details. There is a common set of message types for APIs to use. | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from openapi_client.models.status import Status
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of Status from a JSON string
|
||||
status_instance = Status.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(Status.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
status_dict = status_instance.to_dict()
|
||||
# create an instance of Status from a dict
|
||||
status_form_dict = status.from_dict(status_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)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user