generated from Luis/nextjs-python-web-template
256 lines
6.7 KiB
Markdown
256 lines
6.7 KiB
Markdown
# openapi_client.DefaultApi
|
|
|
|
All URIs are relative to _http://localhost_
|
|
|
|
| Method | HTTP request | Description |
|
|
| ---------------------------------------------------------------- | -------------------- | --------------------- |
|
|
| [**get**](DefaultApi.md#get) | **GET** /ws2_example | Get |
|
|
| [**get_emulated_enpoints**](DefaultApi.md#get_emulated_enpoints) | **GET** /emulate | Get Emulated Enpoints |
|
|
| [**health**](DefaultApi.md#health) | **GET** /health | Health |
|
|
| [**root**](DefaultApi.md#root) | **GET** /{path_name} | Root |
|
|
|
|
# **get**
|
|
|
|
> get()
|
|
|
|
Get
|
|
|
|
### Example
|
|
|
|
```python
|
|
import time
|
|
import os
|
|
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.DefaultApi(api_client)
|
|
|
|
try:
|
|
# Get
|
|
api_instance.get()
|
|
except Exception as e:
|
|
print("Exception when calling DefaultApi->get: %s\n" % e)
|
|
```
|
|
|
|
### Parameters
|
|
|
|
This endpoint does not need any parameter.
|
|
|
|
### 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** | 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)
|
|
|
|
# **get_emulated_enpoints**
|
|
|
|
> str get_emulated_enpoints()
|
|
|
|
Get Emulated Enpoints
|
|
|
|
### Example
|
|
|
|
```python
|
|
import time
|
|
import os
|
|
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.DefaultApi(api_client)
|
|
|
|
try:
|
|
# Get Emulated Enpoints
|
|
api_response = api_instance.get_emulated_enpoints()
|
|
print("The response of DefaultApi->get_emulated_enpoints:\n")
|
|
pprint(api_response)
|
|
except Exception as e:
|
|
print("Exception when calling DefaultApi->get_emulated_enpoints: %s\n" % e)
|
|
```
|
|
|
|
### Parameters
|
|
|
|
This endpoint does not need any parameter.
|
|
|
|
### Return type
|
|
|
|
**str**
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: text/html
|
|
|
|
### HTTP response details
|
|
|
|
| Status code | Description | Response headers |
|
|
| ----------- | ------------------- | ---------------- |
|
|
| **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)
|
|
|
|
# **health**
|
|
|
|
> Machine health()
|
|
|
|
Health
|
|
|
|
### Example
|
|
|
|
```python
|
|
import time
|
|
import os
|
|
import openapi_client
|
|
from openapi_client.models.machine import Machine
|
|
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.DefaultApi(api_client)
|
|
|
|
try:
|
|
# Health
|
|
api_response = api_instance.health()
|
|
print("The response of DefaultApi->health:\n")
|
|
pprint(api_response)
|
|
except Exception as e:
|
|
print("Exception when calling DefaultApi->health: %s\n" % e)
|
|
```
|
|
|
|
### Parameters
|
|
|
|
This endpoint does not need any parameter.
|
|
|
|
### Return type
|
|
|
|
[**Machine**](Machine.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 | - |
|
|
|
|
[[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(path_name)
|
|
|
|
Root
|
|
|
|
### Example
|
|
|
|
```python
|
|
import time
|
|
import os
|
|
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.DefaultApi(api_client)
|
|
path_name = 'path_name_example' # str |
|
|
|
|
try:
|
|
# Root
|
|
api_instance.root(path_name)
|
|
except Exception as e:
|
|
print("Exception when calling DefaultApi->root: %s\n" % e)
|
|
```
|
|
|
|
### Parameters
|
|
|
|
| Name | Type | Description | Notes |
|
|
| ------------- | ------- | ----------- | ----- |
|
|
| **path_name** | **str** | |
|
|
|
|
### 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** | 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)
|