125 lines
4.7 KiB
Markdown
125 lines
4.7 KiB
Markdown
# openapi-client
|
|
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
|
|
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
|
|
- API version: 0.0.1
|
|
- Package version: 1.0.0
|
|
- Generator version: 7.4.0
|
|
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
|
|
|
|
## Requirements.
|
|
|
|
Python 3.7+
|
|
|
|
## Installation & Usage
|
|
### pip install
|
|
|
|
If the python package is hosted on a repository, you can install directly using:
|
|
|
|
```sh
|
|
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
|
|
```
|
|
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
|
|
|
|
Then import the package:
|
|
```python
|
|
import openapi_client
|
|
```
|
|
|
|
### Setuptools
|
|
|
|
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
|
|
|
|
```sh
|
|
python setup.py install --user
|
|
```
|
|
(or `sudo python setup.py install` to install the package for all users)
|
|
|
|
Then import the package:
|
|
```python
|
|
import openapi_client
|
|
```
|
|
|
|
### Tests
|
|
|
|
Execute `pytest` to run the tests.
|
|
|
|
## Getting Started
|
|
|
|
Please follow the [installation procedure](#installation--usage) and then run the following:
|
|
|
|
```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)
|
|
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 ApiException as e:
|
|
print("Exception when calling PeerNetServiceApi->peer_net_service_claim_ice_candidates: %s\n" % e)
|
|
|
|
```
|
|
|
|
## Documentation for API Endpoints
|
|
|
|
All URIs are relative to *http://localhost*
|
|
|
|
Class | Method | HTTP request | Description
|
|
------------ | ------------- | ------------- | -------------
|
|
*PeerNetServiceApi* | [**peer_net_service_claim_ice_candidates**](docs/PeerNetServiceApi.md#peer_net_service_claim_ice_candidates) | **GET** /v1/sessions/{session}/claim/candidates |
|
|
*PeerNetServiceApi* | [**peer_net_service_create_ice_candidate**](docs/PeerNetServiceApi.md#peer_net_service_create_ice_candidate) | **POST** /v1/sessions/{session}/candidates |
|
|
*PeerNetServiceApi* | [**peer_net_service_create_knock**](docs/PeerNetServiceApi.md#peer_net_service_create_knock) | **POST** /v1/servers/{server}/services/{service}/knocks |
|
|
*PeerNetServiceApi* | [**peer_net_service_create_server**](docs/PeerNetServiceApi.md#peer_net_service_create_server) | **POST** /v1/servers |
|
|
*PeerNetServiceApi* | [**peer_net_service_create_service**](docs/PeerNetServiceApi.md#peer_net_service_create_service) | **POST** /v1/servers/{server}/services |
|
|
*PeerNetServiceApi* | [**peer_net_service_delete_server**](docs/PeerNetServiceApi.md#peer_net_service_delete_server) | **DELETE** /v1/servers/* |
|
|
*PeerNetServiceApi* | [**peer_net_service_delete_service**](docs/PeerNetServiceApi.md#peer_net_service_delete_service) | **DELETE** /v1/servers/{server}/services/{service} |
|
|
*PeerNetServiceApi* | [**peer_net_service_get_knock**](docs/PeerNetServiceApi.md#peer_net_service_get_knock) | **GET** /v1/servers/{server}/services/{service}/knocks/{knock} |
|
|
*PeerNetServiceApi* | [**peer_net_service_get_room**](docs/PeerNetServiceApi.md#peer_net_service_get_room) | **GET** /v1/rooms/{room} |
|
|
*PeerNetServiceApi* | [**peer_net_service_list_knocks**](docs/PeerNetServiceApi.md#peer_net_service_list_knocks) | **GET** /v1/servers/{server}/services/{service}/knocks |
|
|
*PeerNetServiceApi* | [**peer_net_service_update_knock**](docs/PeerNetServiceApi.md#peer_net_service_update_knock) | **PATCH** /v1/servers/{server}/services/{service}/knocks/{knock} |
|
|
|
|
|
|
## Documentation For Models
|
|
|
|
- [ClaimIceCandidatesResponse](docs/ClaimIceCandidatesResponse.md)
|
|
- [GoogleProtobufAny](docs/GoogleProtobufAny.md)
|
|
- [IceCandidate](docs/IceCandidate.md)
|
|
- [IceSessionDescription](docs/IceSessionDescription.md)
|
|
- [Knock](docs/Knock.md)
|
|
- [ListKnocksResponse](docs/ListKnocksResponse.md)
|
|
- [Room](docs/Room.md)
|
|
- [Server](docs/Server.md)
|
|
- [Service](docs/Service.md)
|
|
- [Status](docs/Status.md)
|
|
|
|
|
|
<a id="documentation-for-authorization"></a>
|
|
## Documentation For Authorization
|
|
|
|
Endpoints do not require authorization.
|
|
|
|
|
|
## Author
|
|
|
|
|
|
|
|
|