loafle/openapi-generator-original
3
0
Fork 1
mirror of https://github.com/OpenAPITools/openapi-generator.git synced 2025-12-10 22:42:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

[python] Adding constructor parameters to Configuration and improving documentation (#3002)

Browse Source 
* feat(python): Updated configuration's constructor and documentation

* feat(python): Updated documentation

* feat(python): Updated pet project

* feat(python): Updated pet project

* feat(python): Fixing host

* feat(python): Updating pet project

* feat(python): Fixing indentation
This commit is contained in:
Sai Giridhar P
2019-05-29 22:20:26 +05:30
committed by William Cheng
parent 6742302922
commit e3bc228dd5
57 changed files with 3862 additions and 559 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
modules/openapi-generator/src/main/resources/python/api.mustache vendored
View File

@@ -46,10 +46,17 @@ class {{classname}}(object):
{{/sortParamsByRequiredFlag}} {{/sortParamsByRequiredFlag}}
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
{{#allParams}} {{#allParams}}
:param {{dataType}} {{paramName}}:{{#description}} {{{description}}}{{/description}}{{#required}} (required){{/required}}{{#optional}}(optional){{/optional}} :param {{dataType}} {{paramName}}:{{#description}} {{{description}}}{{/description}}{{#required}} (required){{/required}}{{#optional}}(optional){{/optional}}
{{/allParams}} {{/allParams}}
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: {{#returnType}}{{returnType}}{{/returnType}}{{^returnType}}None{{/returnType}} :return: {{#returnType}}{{returnType}}{{/returnType}}{{^returnType}}None{{/returnType}}
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -73,11 +80,20 @@ class {{classname}}(object):
{{/sortParamsByRequiredFlag}} {{/sortParamsByRequiredFlag}}
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
{{#allParams}} {{#allParams}}
:param {{dataType}} {{paramName}}:{{#description}} {{{description}}}{{/description}}{{#required}} (required){{/required}}{{#optional}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/optional}} :param {{dataType}} {{paramName}}:{{#description}} {{{description}}}{{/description}}{{#required}} (required){{/required}}{{#optional}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/optional}}
{{/allParams}} {{/allParams}}
:return: {{#returnType}}{{returnType}}{{/returnType}}{{^returnType}}None{{/returnType}} :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: {{#returnType}}tuple({{returnType}}, status_code(int), headers(HTTPHeaderDict)){{/returnType}}{{^returnType}}None{{/returnType}}
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """

9
modules/openapi-generator/src/main/resources/python/api_doc.mustache vendored
View File

@@ -61,6 +61,15 @@ Name | Type | Description | Notes
- **Content-Type**: {{#consumes}}{{{mediaType}}}{{#hasMore}}, {{/hasMore}}{{/consumes}}{{^consumes}}Not defined{{/consumes}} - **Content-Type**: {{#consumes}}{{{mediaType}}}{{#hasMore}}, {{/hasMore}}{{/consumes}}{{^consumes}}Not defined{{/consumes}}
- **Accept**: {{#produces}}{{{mediaType}}}{{#hasMore}}, {{/hasMore}}{{/produces}}{{^produces}}Not defined{{/produces}} - **Accept**: {{#produces}}{{{mediaType}}}{{#hasMore}}, {{/hasMore}}{{/produces}}{{^produces}}Not defined{{/produces}}
{{#responses.0}}
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
{{#responses}}
**{{code}}** | {{message}} | {{#headers}} * {{baseName}} - {{description}} <br> {{/headers}}{{^headers.0}} - {{/headers.0}} |
{{/responses}}
{{/responses.0}}
[[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)
{{/operation}} {{/operation}}

112
modules/openapi-generator/src/main/resources/python/configuration.mustache vendored
View File

@@ -19,9 +19,9 @@ class TypeWithDefault(type):
super(TypeWithDefault, cls).__init__(name, bases, dct) super(TypeWithDefault, cls).__init__(name, bases, dct)
cls._default = None cls._default = None
def __call__(cls): def __call__(cls, **kwargs):
if cls._default is None: if cls._default is None:
cls._default = type.__call__(cls) cls._default = type.__call__(cls, **kwargs)
return copy.copy(cls._default) return copy.copy(cls._default)
def set_default(cls, default): def set_default(cls, default):
@@ -33,77 +33,109 @@ class Configuration(six.with_metaclass(TypeWithDefault, object)):
Ref: https://openapi-generator.tech Ref: https://openapi-generator.tech
Do not edit the class manually. Do not edit the class manually.
:param host: Base url
:param api_key: Dict to store API key(s)
:param api_key_prefix: Dict to store API prefix (e.g. Bearer)
:param username: Username for HTTP basic authentication
:param password: Password for HTTP basic authentication
""" """
def __init__(self): def __init__(self, host="{{{basePath}}}",
"""Constructor""" api_key={}, api_key_prefix={},
# Default Base url username="", password=""):
self.host = "{{{basePath}}}" """Constructor
# Temp file folder for downloading files """
self.host = host
"""Default Base url
"""
self.temp_folder_path = None self.temp_folder_path = None
"""Temp file folder for downloading files
"""
# Authentication Settings # Authentication Settings
# dict to store API key(s) self.api_key = api_key
self.api_key = {} """dict to store API key(s)
# dict to store API prefix (e.g. Bearer) """
self.api_key_prefix = {} self.api_key_prefix = api_key_prefix
# Username for HTTP basic authentication """dict to store API prefix (e.g. Bearer)
self.username = "" """
# Password for HTTP basic authentication self.username = username
self.password = "" """Username for HTTP basic authentication
"""
self.password = password
"""Password for HTTP basic authentication
"""
{{#hasOAuthMethods}} {{#hasOAuthMethods}}
# access token for OAuth/Bearer
self.access_token = "" self.access_token = ""
"""access token for OAuth/Bearer
"""
{{/hasOAuthMethods}} {{/hasOAuthMethods}}
{{^hasOAuthMethods}} {{^hasOAuthMethods}}
{{#hasBearerMethods}} {{#hasBearerMethods}}
# access token for OAuth/Bearer
self.access_token = "" self.access_token = ""
"""access token for OAuth/Bearer
"""
{{/hasBearerMethods}} {{/hasBearerMethods}}
{{/hasOAuthMethods}} {{/hasOAuthMethods}}
# Logging Settings
self.logger = {} self.logger = {}
"""Logging Settings
"""
self.logger["package_logger"] = logging.getLogger("{{packageName}}") self.logger["package_logger"] = logging.getLogger("{{packageName}}")
self.logger["urllib3_logger"] = logging.getLogger("urllib3") self.logger["urllib3_logger"] = logging.getLogger("urllib3")
# Log format
self.logger_format = '%(asctime)s %(levelname)s %(message)s' self.logger_format = '%(asctime)s %(levelname)s %(message)s'
# Log stream handler """Log format
"""
self.logger_stream_handler = None self.logger_stream_handler = None
# Log file handler """Log stream handler
"""
self.logger_file_handler = None self.logger_file_handler = None
# Debug file location """Log file handler
"""
self.logger_file = None self.logger_file = None
# Debug switch """Debug file location
"""
self.debug = False self.debug = False
"""Debug switch
"""
# SSL/TLS verification
# Set this to false to skip verifying SSL certificate when calling API
# from https server.
self.verify_ssl = True self.verify_ssl = True
# Set this to customize the certificate file to verify the peer. """SSL/TLS verification
Set this to false to skip verifying SSL certificate when calling API
from https server.
"""
self.ssl_ca_cert = None self.ssl_ca_cert = None
# client certificate file """Set this to customize the certificate file to verify the peer.
"""
self.cert_file = None self.cert_file = None
# client key file """client certificate file
"""
self.key_file = None self.key_file = None
# Set this to True/False to enable/disable SSL hostname verification. """client key file
"""
self.assert_hostname = None self.assert_hostname = None
"""Set this to True/False to enable/disable SSL hostname verification.
"""
# urllib3 connection pool's maximum number of connections saved
# per pool. urllib3 uses 1 connection as default value, but this is
# not the best value when you are making a lot of possibly parallel
# requests to the same host, which is often the case here.
# cpu_count * 5 is used as default value to increase performance.
self.connection_pool_maxsize = multiprocessing.cpu_count() * 5 self.connection_pool_maxsize = multiprocessing.cpu_count() * 5
"""urllib3 connection pool's maximum number of connections saved
per pool. urllib3 uses 1 connection as default value, but this is
not the best value when you are making a lot of possibly parallel
requests to the same host, which is often the case here.
cpu_count * 5 is used as default value to increase performance.
"""
# Proxy URL
self.proxy = None self.proxy = None
# Proxy headers """Proxy URL
"""
self.proxy_headers = None self.proxy_headers = None
# Safe chars for path_param """Proxy headers
"""
self.safe_chars_for_path_param = '' self.safe_chars_for_path_param = ''
# Adding retries to override urllib3 default value 3 """Safe chars for path_param
"""
self.retries = None self.retries = None
"""Adding retries to override urllib3 default value 3
"""
@property @property
def logger_file(self): def logger_file(self):

5
samples/client/petstore/python-asyncio/docs/AnotherFakeApi.md
View File

@@ -54,5 +54,10 @@ No authorization required
- **Content-Type**: application/json - **Content-Type**: application/json
- **Accept**: application/json - **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
[[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)

67
samples/client/petstore/python-asyncio/docs/FakeApi.md
View File

@@ -65,6 +65,11 @@ No authorization required
- **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 - **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
[[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)
# **fake_outer_boolean_serialize** # **fake_outer_boolean_serialize**
@@ -113,6 +118,11 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: */* - **Accept**: */*
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Output boolean | - |
[[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)
# **fake_outer_composite_serialize** # **fake_outer_composite_serialize**
@@ -161,6 +171,11 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: */* - **Accept**: */*
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Output composite | - |
[[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)
# **fake_outer_number_serialize** # **fake_outer_number_serialize**
@@ -209,6 +224,11 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: */* - **Accept**: */*
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Output number | - |
[[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)
# **fake_outer_string_serialize** # **fake_outer_string_serialize**
@@ -257,6 +277,11 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: */* - **Accept**: */*
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Output string | - |
[[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)
# **test_body_with_file_schema** # **test_body_with_file_schema**
@@ -304,6 +329,11 @@ No authorization required
- **Content-Type**: application/json - **Content-Type**: application/json
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Success | - |
[[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)
# **test_body_with_query_params** # **test_body_with_query_params**
@@ -351,6 +381,11 @@ No authorization required
- **Content-Type**: application/json - **Content-Type**: application/json
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Success | - |
[[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)
# **test_client_model** # **test_client_model**
@@ -400,6 +435,11 @@ No authorization required
- **Content-Type**: application/json - **Content-Type**: application/json
- **Accept**: application/json - **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
[[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)
# **test_endpoint_parameters** # **test_endpoint_parameters**
@@ -479,6 +519,12 @@ void (empty response body)
- **Content-Type**: application/x-www-form-urlencoded - **Content-Type**: application/x-www-form-urlencoded
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**400** | Invalid username supplied | - |
**404** | User not found | - |
[[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)
# **test_enum_parameters** # **test_enum_parameters**
@@ -541,6 +587,12 @@ No authorization required
- **Content-Type**: application/x-www-form-urlencoded - **Content-Type**: application/x-www-form-urlencoded
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**400** | Invalid request | - |
**404** | Not found | - |
[[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)
# **test_group_parameters** # **test_group_parameters**
@@ -599,6 +651,11 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**400** | Someting wrong | - |
[[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)
# **test_inline_additional_properties** # **test_inline_additional_properties**
@@ -645,6 +702,11 @@ No authorization required
- **Content-Type**: application/json - **Content-Type**: application/json
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
[[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)
# **test_json_form_data** # **test_json_form_data**
@@ -693,5 +755,10 @@ No authorization required
- **Content-Type**: application/x-www-form-urlencoded - **Content-Type**: application/x-www-form-urlencoded
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
[[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)

5
samples/client/petstore/python-asyncio/docs/FakeClassnameTags123Api.md
View File

@@ -60,5 +60,10 @@ Name | Type | Description | Notes
- **Content-Type**: application/json - **Content-Type**: application/json
- **Accept**: application/json - **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
[[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)

54
samples/client/petstore/python-asyncio/docs/PetApi.md
View File

@@ -63,6 +63,12 @@ void (empty response body)
- **Content-Type**: application/json, application/xml - **Content-Type**: application/json, application/xml
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
**405** | Invalid input | - |
[[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_pet** # **delete_pet**
@@ -115,6 +121,12 @@ void (empty response body)
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
**400** | Invalid pet value | - |
[[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)
# **find_pets_by_status** # **find_pets_by_status**
@@ -168,6 +180,12 @@ Name | Type | Description | Notes
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/xml, application/json - **Accept**: application/xml, application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
**400** | Invalid status value | - |
[[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)
# **find_pets_by_tags** # **find_pets_by_tags**
@@ -221,6 +239,12 @@ Name | Type | Description | Notes
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/xml, application/json - **Accept**: application/xml, application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
**400** | Invalid tag value | - |
[[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_pet_by_id** # **get_pet_by_id**
@@ -276,6 +300,13 @@ Name | Type | Description | Notes
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/xml, application/json - **Accept**: application/xml, application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
**400** | Invalid ID supplied | - |
**404** | Pet not found | - |
[[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)
# **update_pet** # **update_pet**
@@ -326,6 +357,14 @@ void (empty response body)
- **Content-Type**: application/json, application/xml - **Content-Type**: application/json, application/xml
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
**400** | Invalid ID supplied | - |
**404** | Pet not found | - |
**405** | Validation exception | - |
[[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)
# **update_pet_with_form** # **update_pet_with_form**
@@ -380,6 +419,11 @@ void (empty response body)
- **Content-Type**: application/x-www-form-urlencoded - **Content-Type**: application/x-www-form-urlencoded
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**405** | Invalid input | - |
[[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)
# **upload_file** # **upload_file**
@@ -435,6 +479,11 @@ Name | Type | Description | Notes
- **Content-Type**: multipart/form-data - **Content-Type**: multipart/form-data
- **Accept**: application/json - **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
[[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)
# **upload_file_with_required_file** # **upload_file_with_required_file**
@@ -490,5 +539,10 @@ Name | Type | Description | Notes
- **Content-Type**: multipart/form-data - **Content-Type**: multipart/form-data
- **Accept**: application/json - **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
[[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)

24
samples/client/petstore/python-asyncio/docs/StoreApi.md
View File

@@ -56,6 +56,12 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**400** | Invalid ID supplied | - |
**404** | Order not found | - |
[[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_inventory** # **get_inventory**
@@ -107,6 +113,11 @@ This endpoint does not need any parameter.
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/json - **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
[[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_order_by_id** # **get_order_by_id**
@@ -156,6 +167,13 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/xml, application/json - **Accept**: application/xml, application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
**400** | Invalid ID supplied | - |
**404** | Order not found | - |
[[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)
# **place_order** # **place_order**
@@ -203,5 +221,11 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/xml, application/json - **Accept**: application/xml, application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
**400** | Invalid Order | - |
[[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)

45
samples/client/petstore/python-asyncio/docs/UserApi.md
View File

@@ -60,6 +60,11 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**0** | successful operation | - |
[[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_users_with_array_input** # **create_users_with_array_input**
@@ -106,6 +111,11 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**0** | successful operation | - |
[[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_users_with_list_input** # **create_users_with_list_input**
@@ -152,6 +162,11 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**0** | successful operation | - |
[[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_user** # **delete_user**
@@ -200,6 +215,12 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**400** | Invalid username supplied | - |
**404** | User not found | - |
[[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_user_by_name** # **get_user_by_name**
@@ -247,6 +268,13 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/xml, application/json - **Accept**: application/xml, application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
**400** | Invalid username supplied | - |
**404** | User not found | - |
[[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)
# **login_user** # **login_user**
@@ -296,6 +324,12 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/xml, application/json - **Accept**: application/xml, application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | * X-Rate-Limit - calls per hour allowed by the user <br> * X-Expires-After - date in UTC when token expires <br> |
**400** | Invalid username/password supplied | - |
[[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)
# **logout_user** # **logout_user**
@@ -338,6 +372,11 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**0** | successful operation | - |
[[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)
# **update_user** # **update_user**
@@ -388,5 +427,11 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**400** | Invalid user supplied | - |
**404** | User not found | - |
[[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)

22
samples/client/petstore/python-asyncio/petstore_api/api/another_fake_api.py
View File

@@ -45,8 +45,15 @@ class AnotherFakeApi(object):
>>> thread = api.call_123_test_special_tags(body, async_req=True) >>> thread = api.call_123_test_special_tags(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Client body: client model (required) :param Client body: client model (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: Client :return: Client
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -63,9 +70,18 @@ class AnotherFakeApi(object):
>>> thread = api.call_123_test_special_tags_with_http_info(body, async_req=True) >>> thread = api.call_123_test_special_tags_with_http_info(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Client body: client model (required) :param Client body: client model (required)
:return: Client :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(Client, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """

270
samples/client/petstore/python-asyncio/petstore_api/api/fake_api.py
View File

@@ -45,8 +45,15 @@ class FakeApi(object):
>>> thread = api.create_xml_item(xml_item, async_req=True) >>> thread = api.create_xml_item(xml_item, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param XmlItem xml_item: XmlItem Body (required) :param XmlItem xml_item: XmlItem Body (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -63,8 +70,17 @@ class FakeApi(object):
>>> thread = api.create_xml_item_with_http_info(xml_item, async_req=True) >>> thread = api.create_xml_item_with_http_info(xml_item, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param XmlItem xml_item: XmlItem Body (required) :param XmlItem xml_item: XmlItem Body (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -137,8 +153,15 @@ class FakeApi(object):
>>> thread = api.fake_outer_boolean_serialize(async_req=True) >>> thread = api.fake_outer_boolean_serialize(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param bool body: Input boolean as post body :param bool body: Input boolean as post body
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: bool :return: bool
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -155,9 +178,18 @@ class FakeApi(object):
>>> thread = api.fake_outer_boolean_serialize_with_http_info(async_req=True) >>> thread = api.fake_outer_boolean_serialize_with_http_info(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param bool body: Input boolean as post body :param bool body: Input boolean as post body
:return: bool :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(bool, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -225,8 +257,15 @@ class FakeApi(object):
>>> thread = api.fake_outer_composite_serialize(async_req=True) >>> thread = api.fake_outer_composite_serialize(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param OuterComposite body: Input composite as post body :param OuterComposite body: Input composite as post body
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: OuterComposite :return: OuterComposite
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -243,9 +282,18 @@ class FakeApi(object):
>>> thread = api.fake_outer_composite_serialize_with_http_info(async_req=True) >>> thread = api.fake_outer_composite_serialize_with_http_info(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param OuterComposite body: Input composite as post body :param OuterComposite body: Input composite as post body
:return: OuterComposite :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(OuterComposite, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -313,8 +361,15 @@ class FakeApi(object):
>>> thread = api.fake_outer_number_serialize(async_req=True) >>> thread = api.fake_outer_number_serialize(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param float body: Input number as post body :param float body: Input number as post body
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: float :return: float
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -331,9 +386,18 @@ class FakeApi(object):
>>> thread = api.fake_outer_number_serialize_with_http_info(async_req=True) >>> thread = api.fake_outer_number_serialize_with_http_info(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param float body: Input number as post body :param float body: Input number as post body
:return: float :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(float, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -401,8 +465,15 @@ class FakeApi(object):
>>> thread = api.fake_outer_string_serialize(async_req=True) >>> thread = api.fake_outer_string_serialize(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str body: Input string as post body :param str body: Input string as post body
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: str :return: str
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -419,9 +490,18 @@ class FakeApi(object):
>>> thread = api.fake_outer_string_serialize_with_http_info(async_req=True) >>> thread = api.fake_outer_string_serialize_with_http_info(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str body: Input string as post body :param str body: Input string as post body
:return: str :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(str, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -489,8 +569,15 @@ class FakeApi(object):
>>> thread = api.test_body_with_file_schema(body, async_req=True) >>> thread = api.test_body_with_file_schema(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param FileSchemaTestClass body: (required) :param FileSchemaTestClass body: (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -507,8 +594,17 @@ class FakeApi(object):
>>> thread = api.test_body_with_file_schema_with_http_info(body, async_req=True) >>> thread = api.test_body_with_file_schema_with_http_info(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param FileSchemaTestClass body: (required) :param FileSchemaTestClass body: (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -580,9 +676,16 @@ class FakeApi(object):
>>> thread = api.test_body_with_query_params(query, body, async_req=True) >>> thread = api.test_body_with_query_params(query, body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str query: (required) :param str query: (required)
:param User body: (required) :param User body: (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -598,9 +701,18 @@ class FakeApi(object):
>>> thread = api.test_body_with_query_params_with_http_info(query, body, async_req=True) >>> thread = api.test_body_with_query_params_with_http_info(query, body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str query: (required) :param str query: (required)
:param User body: (required) :param User body: (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -679,8 +791,15 @@ class FakeApi(object):
>>> thread = api.test_client_model(body, async_req=True) >>> thread = api.test_client_model(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Client body: client model (required) :param Client body: client model (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: Client :return: Client
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -697,9 +816,18 @@ class FakeApi(object):
>>> thread = api.test_client_model_with_http_info(body, async_req=True) >>> thread = api.test_client_model_with_http_info(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Client body: client model (required) :param Client body: client model (required)
:return: Client :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(Client, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -775,7 +903,7 @@ class FakeApi(object):
>>> thread = api.test_endpoint_parameters(number, double, pattern_without_delimiter, byte, async_req=True) >>> thread = api.test_endpoint_parameters(number, double, pattern_without_delimiter, byte, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param float number: None (required) :param float number: None (required)
:param float double: None (required) :param float double: None (required)
:param str pattern_without_delimiter: None (required) :param str pattern_without_delimiter: None (required)
@@ -790,6 +918,13 @@ class FakeApi(object):
:param datetime date_time: None :param datetime date_time: None
:param str password: None :param str password: None
:param str param_callback: None :param str param_callback: None
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -806,7 +941,7 @@ class FakeApi(object):
>>> thread = api.test_endpoint_parameters_with_http_info(number, double, pattern_without_delimiter, byte, async_req=True) >>> thread = api.test_endpoint_parameters_with_http_info(number, double, pattern_without_delimiter, byte, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param float number: None (required) :param float number: None (required)
:param float double: None (required) :param float double: None (required)
:param str pattern_without_delimiter: None (required) :param str pattern_without_delimiter: None (required)
@@ -821,6 +956,15 @@ class FakeApi(object):
:param datetime date_time: None :param datetime date_time: None
:param str password: None :param str password: None
:param str param_callback: None :param str param_callback: None
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -959,7 +1103,7 @@ class FakeApi(object):
>>> thread = api.test_enum_parameters(async_req=True) >>> thread = api.test_enum_parameters(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param list[str] enum_header_string_array: Header parameter enum test (string array) :param list[str] enum_header_string_array: Header parameter enum test (string array)
:param str enum_header_string: Header parameter enum test (string) :param str enum_header_string: Header parameter enum test (string)
:param list[str] enum_query_string_array: Query parameter enum test (string array) :param list[str] enum_query_string_array: Query parameter enum test (string array)
@@ -968,6 +1112,13 @@ class FakeApi(object):
:param float enum_query_double: Query parameter enum test (double) :param float enum_query_double: Query parameter enum test (double)
:param list[str] enum_form_string_array: Form parameter enum test (string array) :param list[str] enum_form_string_array: Form parameter enum test (string array)
:param str enum_form_string: Form parameter enum test (string) :param str enum_form_string: Form parameter enum test (string)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -984,7 +1135,7 @@ class FakeApi(object):
>>> thread = api.test_enum_parameters_with_http_info(async_req=True) >>> thread = api.test_enum_parameters_with_http_info(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param list[str] enum_header_string_array: Header parameter enum test (string array) :param list[str] enum_header_string_array: Header parameter enum test (string array)
:param str enum_header_string: Header parameter enum test (string) :param str enum_header_string: Header parameter enum test (string)
:param list[str] enum_query_string_array: Query parameter enum test (string array) :param list[str] enum_query_string_array: Query parameter enum test (string array)
@@ -993,6 +1144,15 @@ class FakeApi(object):
:param float enum_query_double: Query parameter enum test (double) :param float enum_query_double: Query parameter enum test (double)
:param list[str] enum_form_string_array: Form parameter enum test (string array) :param list[str] enum_form_string_array: Form parameter enum test (string array)
:param str enum_form_string: Form parameter enum test (string) :param str enum_form_string: Form parameter enum test (string)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -1078,13 +1238,20 @@ class FakeApi(object):
>>> thread = api.test_group_parameters(required_string_group, required_boolean_group, required_int64_group, async_req=True) >>> thread = api.test_group_parameters(required_string_group, required_boolean_group, required_int64_group, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int required_string_group: Required String in group parameters (required) :param int required_string_group: Required String in group parameters (required)
:param bool required_boolean_group: Required Boolean in group parameters (required) :param bool required_boolean_group: Required Boolean in group parameters (required)
:param int required_int64_group: Required Integer in group parameters (required) :param int required_int64_group: Required Integer in group parameters (required)
:param int string_group: String in group parameters :param int string_group: String in group parameters
:param bool boolean_group: Boolean in group parameters :param bool boolean_group: Boolean in group parameters
:param int int64_group: Integer in group parameters :param int int64_group: Integer in group parameters
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -1101,13 +1268,22 @@ class FakeApi(object):
>>> thread = api.test_group_parameters_with_http_info(required_string_group, required_boolean_group, required_int64_group, async_req=True) >>> thread = api.test_group_parameters_with_http_info(required_string_group, required_boolean_group, required_int64_group, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int required_string_group: Required String in group parameters (required) :param int required_string_group: Required String in group parameters (required)
:param bool required_boolean_group: Required Boolean in group parameters (required) :param bool required_boolean_group: Required Boolean in group parameters (required)
:param int required_int64_group: Required Integer in group parameters (required) :param int required_int64_group: Required Integer in group parameters (required)
:param int string_group: String in group parameters :param int string_group: String in group parameters
:param bool boolean_group: Boolean in group parameters :param bool boolean_group: Boolean in group parameters
:param int int64_group: Integer in group parameters :param int int64_group: Integer in group parameters
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -1193,8 +1369,15 @@ class FakeApi(object):
>>> thread = api.test_inline_additional_properties(param, async_req=True) >>> thread = api.test_inline_additional_properties(param, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param dict(str, str) param: request body (required) :param dict(str, str) param: request body (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -1210,8 +1393,17 @@ class FakeApi(object):
>>> thread = api.test_inline_additional_properties_with_http_info(param, async_req=True) >>> thread = api.test_inline_additional_properties_with_http_info(param, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param dict(str, str) param: request body (required) :param dict(str, str) param: request body (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -1283,9 +1475,16 @@ class FakeApi(object):
>>> thread = api.test_json_form_data(param, param2, async_req=True) >>> thread = api.test_json_form_data(param, param2, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str param: field1 (required) :param str param: field1 (required)
:param str param2: field2 (required) :param str param2: field2 (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -1301,9 +1500,18 @@ class FakeApi(object):
>>> thread = api.test_json_form_data_with_http_info(param, param2, async_req=True) >>> thread = api.test_json_form_data_with_http_info(param, param2, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str param: field1 (required) :param str param: field1 (required)
:param str param2: field2 (required) :param str param2: field2 (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.

22
samples/client/petstore/python-asyncio/petstore_api/api/fake_classname_tags_123_api.py
View File

@@ -45,8 +45,15 @@ class FakeClassnameTags123Api(object):
>>> thread = api.test_classname(body, async_req=True) >>> thread = api.test_classname(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Client body: client model (required) :param Client body: client model (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: Client :return: Client
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -63,9 +70,18 @@ class FakeClassnameTags123Api(object):
>>> thread = api.test_classname_with_http_info(body, async_req=True) >>> thread = api.test_classname_with_http_info(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Client body: client model (required) :param Client body: client model (required)
:return: Client :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(Client, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """

190
samples/client/petstore/python-asyncio/petstore_api/api/pet_api.py
View File

@@ -44,8 +44,15 @@ class PetApi(object):
>>> thread = api.add_pet(body, async_req=True) >>> thread = api.add_pet(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Pet body: Pet object that needs to be added to the store (required) :param Pet body: Pet object that needs to be added to the store (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -61,8 +68,17 @@ class PetApi(object):
>>> thread = api.add_pet_with_http_info(body, async_req=True) >>> thread = api.add_pet_with_http_info(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Pet body: Pet object that needs to be added to the store (required) :param Pet body: Pet object that needs to be added to the store (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -134,9 +150,16 @@ class PetApi(object):
>>> thread = api.delete_pet(pet_id, async_req=True) >>> thread = api.delete_pet(pet_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int pet_id: Pet id to delete (required) :param int pet_id: Pet id to delete (required)
:param str api_key: :param str api_key:
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -152,9 +175,18 @@ class PetApi(object):
>>> thread = api.delete_pet_with_http_info(pet_id, async_req=True) >>> thread = api.delete_pet_with_http_info(pet_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int pet_id: Pet id to delete (required) :param int pet_id: Pet id to delete (required)
:param str api_key: :param str api_key:
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -225,8 +257,15 @@ class PetApi(object):
>>> thread = api.find_pets_by_status(status, async_req=True) >>> thread = api.find_pets_by_status(status, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param list[str] status: Status values that need to be considered for filter (required) :param list[str] status: Status values that need to be considered for filter (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: list[Pet] :return: list[Pet]
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -243,9 +282,18 @@ class PetApi(object):
>>> thread = api.find_pets_by_status_with_http_info(status, async_req=True) >>> thread = api.find_pets_by_status_with_http_info(status, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param list[str] status: Status values that need to be considered for filter (required) :param list[str] status: Status values that need to be considered for filter (required)
:return: list[Pet] :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(list[Pet], status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -318,8 +366,15 @@ class PetApi(object):
>>> thread = api.find_pets_by_tags(tags, async_req=True) >>> thread = api.find_pets_by_tags(tags, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param list[str] tags: Tags to filter by (required) :param list[str] tags: Tags to filter by (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: list[Pet] :return: list[Pet]
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -336,9 +391,18 @@ class PetApi(object):
>>> thread = api.find_pets_by_tags_with_http_info(tags, async_req=True) >>> thread = api.find_pets_by_tags_with_http_info(tags, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param list[str] tags: Tags to filter by (required) :param list[str] tags: Tags to filter by (required)
:return: list[Pet] :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(list[Pet], status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -411,8 +475,15 @@ class PetApi(object):
>>> thread = api.get_pet_by_id(pet_id, async_req=True) >>> thread = api.get_pet_by_id(pet_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int pet_id: ID of pet to return (required) :param int pet_id: ID of pet to return (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: Pet :return: Pet
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -429,9 +500,18 @@ class PetApi(object):
>>> thread = api.get_pet_by_id_with_http_info(pet_id, async_req=True) >>> thread = api.get_pet_by_id_with_http_info(pet_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int pet_id: ID of pet to return (required) :param int pet_id: ID of pet to return (required)
:return: Pet :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(Pet, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -502,8 +582,15 @@ class PetApi(object):
>>> thread = api.update_pet(body, async_req=True) >>> thread = api.update_pet(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Pet body: Pet object that needs to be added to the store (required) :param Pet body: Pet object that needs to be added to the store (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -519,8 +606,17 @@ class PetApi(object):
>>> thread = api.update_pet_with_http_info(body, async_req=True) >>> thread = api.update_pet_with_http_info(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Pet body: Pet object that needs to be added to the store (required) :param Pet body: Pet object that needs to be added to the store (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -592,10 +688,17 @@ class PetApi(object):
>>> thread = api.update_pet_with_form(pet_id, async_req=True) >>> thread = api.update_pet_with_form(pet_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int pet_id: ID of pet that needs to be updated (required) :param int pet_id: ID of pet that needs to be updated (required)
:param str name: Updated name of the pet :param str name: Updated name of the pet
:param str status: Updated status of the pet :param str status: Updated status of the pet
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -611,10 +714,19 @@ class PetApi(object):
>>> thread = api.update_pet_with_form_with_http_info(pet_id, async_req=True) >>> thread = api.update_pet_with_form_with_http_info(pet_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int pet_id: ID of pet that needs to be updated (required) :param int pet_id: ID of pet that needs to be updated (required)
:param str name: Updated name of the pet :param str name: Updated name of the pet
:param str status: Updated status of the pet :param str status: Updated status of the pet
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -690,10 +802,17 @@ class PetApi(object):
>>> thread = api.upload_file(pet_id, async_req=True) >>> thread = api.upload_file(pet_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int pet_id: ID of pet to update (required) :param int pet_id: ID of pet to update (required)
:param str additional_metadata: Additional data to pass to server :param str additional_metadata: Additional data to pass to server
:param file file: file to upload :param file file: file to upload
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: ApiResponse :return: ApiResponse
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -709,11 +828,20 @@ class PetApi(object):
>>> thread = api.upload_file_with_http_info(pet_id, async_req=True) >>> thread = api.upload_file_with_http_info(pet_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int pet_id: ID of pet to update (required) :param int pet_id: ID of pet to update (required)
:param str additional_metadata: Additional data to pass to server :param str additional_metadata: Additional data to pass to server
:param file file: file to upload :param file file: file to upload
:return: ApiResponse :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(ApiResponse, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -792,10 +920,17 @@ class PetApi(object):
>>> thread = api.upload_file_with_required_file(pet_id, required_file, async_req=True) >>> thread = api.upload_file_with_required_file(pet_id, required_file, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int pet_id: ID of pet to update (required) :param int pet_id: ID of pet to update (required)
:param file required_file: file to upload (required) :param file required_file: file to upload (required)
:param str additional_metadata: Additional data to pass to server :param str additional_metadata: Additional data to pass to server
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: ApiResponse :return: ApiResponse
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -811,11 +946,20 @@ class PetApi(object):
>>> thread = api.upload_file_with_required_file_with_http_info(pet_id, required_file, async_req=True) >>> thread = api.upload_file_with_required_file_with_http_info(pet_id, required_file, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int pet_id: ID of pet to update (required) :param int pet_id: ID of pet to update (required)
:param file required_file: file to upload (required) :param file required_file: file to upload (required)
:param str additional_metadata: Additional data to pass to server :param str additional_metadata: Additional data to pass to server
:return: ApiResponse :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(ApiResponse, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """

86
samples/client/petstore/python-asyncio/petstore_api/api/store_api.py
View File

@@ -45,8 +45,15 @@ class StoreApi(object):
>>> thread = api.delete_order(order_id, async_req=True) >>> thread = api.delete_order(order_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str order_id: ID of the order that needs to be deleted (required) :param str order_id: ID of the order that needs to be deleted (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -63,8 +70,17 @@ class StoreApi(object):
>>> thread = api.delete_order_with_http_info(order_id, async_req=True) >>> thread = api.delete_order_with_http_info(order_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str order_id: ID of the order that needs to be deleted (required) :param str order_id: ID of the order that needs to be deleted (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -133,7 +149,14 @@ class StoreApi(object):
>>> thread = api.get_inventory(async_req=True) >>> thread = api.get_inventory(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: dict(str, int) :return: dict(str, int)
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -150,8 +173,17 @@ class StoreApi(object):
>>> thread = api.get_inventory_with_http_info(async_req=True) >>> thread = api.get_inventory_with_http_info(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:return: dict(str, int) :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(dict(str, int), status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -217,8 +249,15 @@ class StoreApi(object):
>>> thread = api.get_order_by_id(order_id, async_req=True) >>> thread = api.get_order_by_id(order_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int order_id: ID of pet that needs to be fetched (required) :param int order_id: ID of pet that needs to be fetched (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: Order :return: Order
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -235,9 +274,18 @@ class StoreApi(object):
>>> thread = api.get_order_by_id_with_http_info(order_id, async_req=True) >>> thread = api.get_order_by_id_with_http_info(order_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int order_id: ID of pet that needs to be fetched (required) :param int order_id: ID of pet that needs to be fetched (required)
:return: Order :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(Order, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -312,8 +360,15 @@ class StoreApi(object):
>>> thread = api.place_order(body, async_req=True) >>> thread = api.place_order(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Order body: order placed for purchasing the pet (required) :param Order body: order placed for purchasing the pet (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: Order :return: Order
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -329,9 +384,18 @@ class StoreApi(object):
>>> thread = api.place_order_with_http_info(body, async_req=True) >>> thread = api.place_order_with_http_info(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Order body: order placed for purchasing the pet (required) :param Order body: order placed for purchasing the pet (required)
:return: Order :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(Order, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """

164
samples/client/petstore/python-asyncio/petstore_api/api/user_api.py
View File

@@ -45,8 +45,15 @@ class UserApi(object):
>>> thread = api.create_user(body, async_req=True) >>> thread = api.create_user(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param User body: Created user object (required) :param User body: Created user object (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -63,8 +70,17 @@ class UserApi(object):
>>> thread = api.create_user_with_http_info(body, async_req=True) >>> thread = api.create_user_with_http_info(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param User body: Created user object (required) :param User body: Created user object (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -132,8 +148,15 @@ class UserApi(object):
>>> thread = api.create_users_with_array_input(body, async_req=True) >>> thread = api.create_users_with_array_input(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param list[User] body: List of user object (required) :param list[User] body: List of user object (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -149,8 +172,17 @@ class UserApi(object):
>>> thread = api.create_users_with_array_input_with_http_info(body, async_req=True) >>> thread = api.create_users_with_array_input_with_http_info(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param list[User] body: List of user object (required) :param list[User] body: List of user object (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -218,8 +250,15 @@ class UserApi(object):
>>> thread = api.create_users_with_list_input(body, async_req=True) >>> thread = api.create_users_with_list_input(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param list[User] body: List of user object (required) :param list[User] body: List of user object (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -235,8 +274,17 @@ class UserApi(object):
>>> thread = api.create_users_with_list_input_with_http_info(body, async_req=True) >>> thread = api.create_users_with_list_input_with_http_info(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param list[User] body: List of user object (required) :param list[User] body: List of user object (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -305,8 +353,15 @@ class UserApi(object):
>>> thread = api.delete_user(username, async_req=True) >>> thread = api.delete_user(username, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str username: The name that needs to be deleted (required) :param str username: The name that needs to be deleted (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -323,8 +378,17 @@ class UserApi(object):
>>> thread = api.delete_user_with_http_info(username, async_req=True) >>> thread = api.delete_user_with_http_info(username, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str username: The name that needs to be deleted (required) :param str username: The name that needs to be deleted (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -392,8 +456,15 @@ class UserApi(object):
>>> thread = api.get_user_by_name(username, async_req=True) >>> thread = api.get_user_by_name(username, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str username: The name that needs to be fetched. Use user1 for testing. (required) :param str username: The name that needs to be fetched. Use user1 for testing. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: User :return: User
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -409,9 +480,18 @@ class UserApi(object):
>>> thread = api.get_user_by_name_with_http_info(username, async_req=True) >>> thread = api.get_user_by_name_with_http_info(username, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str username: The name that needs to be fetched. Use user1 for testing. (required) :param str username: The name that needs to be fetched. Use user1 for testing. (required)
:return: User :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(User, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -482,9 +562,16 @@ class UserApi(object):
>>> thread = api.login_user(username, password, async_req=True) >>> thread = api.login_user(username, password, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str username: The user name for login (required) :param str username: The user name for login (required)
:param str password: The password for login in clear text (required) :param str password: The password for login in clear text (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: str :return: str
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -500,10 +587,19 @@ class UserApi(object):
>>> thread = api.login_user_with_http_info(username, password, async_req=True) >>> thread = api.login_user_with_http_info(username, password, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str username: The user name for login (required) :param str username: The user name for login (required)
:param str password: The password for login in clear text (required) :param str password: The password for login in clear text (required)
:return: str :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(str, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -580,7 +676,14 @@ class UserApi(object):
>>> thread = api.logout_user(async_req=True) >>> thread = api.logout_user(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -596,7 +699,16 @@ class UserApi(object):
>>> thread = api.logout_user_with_http_info(async_req=True) >>> thread = api.logout_user_with_http_info(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -659,9 +771,16 @@ class UserApi(object):
>>> thread = api.update_user(username, body, async_req=True) >>> thread = api.update_user(username, body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str username: name that need to be deleted (required) :param str username: name that need to be deleted (required)
:param User body: Updated user object (required) :param User body: Updated user object (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -678,9 +797,18 @@ class UserApi(object):
>>> thread = api.update_user_with_http_info(username, body, async_req=True) >>> thread = api.update_user_with_http_info(username, body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str username: name that need to be deleted (required) :param str username: name that need to be deleted (required)
:param User body: Updated user object (required) :param User body: Updated user object (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.

109
samples/client/petstore/python-asyncio/petstore_api/configuration.py
View File

@@ -27,9 +27,9 @@ class TypeWithDefault(type):
super(TypeWithDefault, cls).__init__(name, bases, dct) super(TypeWithDefault, cls).__init__(name, bases, dct)
cls._default = None cls._default = None
def __call__(cls): def __call__(cls, **kwargs):
if cls._default is None: if cls._default is None:
cls._default = type.__call__(cls) cls._default = type.__call__(cls, **kwargs)
return copy.copy(cls._default) return copy.copy(cls._default)
def set_default(cls, default): def set_default(cls, default):
@@ -41,69 +41,100 @@ class Configuration(six.with_metaclass(TypeWithDefault, object)):
Ref: https://openapi-generator.tech Ref: https://openapi-generator.tech
Do not edit the class manually. Do not edit the class manually.
:param host: Base url
:param api_key: Dict to store API key(s)
:param api_key_prefix: Dict to store API prefix (e.g. Bearer)
:param username: Username for HTTP basic authentication
:param password: Password for HTTP basic authentication
""" """
def __init__(self): def __init__(self, host="http://petstore.swagger.io:80/v2",
"""Constructor""" api_key={}, api_key_prefix={},
# Default Base url username="", password=""):
self.host = "http://petstore.swagger.io:80/v2" """Constructor
# Temp file folder for downloading files """
self.host = host
"""Default Base url
"""
self.temp_folder_path = None self.temp_folder_path = None
"""Temp file folder for downloading files
"""
# Authentication Settings # Authentication Settings
# dict to store API key(s) self.api_key = api_key
self.api_key = {} """dict to store API key(s)
# dict to store API prefix (e.g. Bearer) """
self.api_key_prefix = {} self.api_key_prefix = api_key_prefix
# Username for HTTP basic authentication """dict to store API prefix (e.g. Bearer)
self.username = "" """
# Password for HTTP basic authentication self.username = username
self.password = "" """Username for HTTP basic authentication
# access token for OAuth/Bearer """
self.password = password
"""Password for HTTP basic authentication
"""
self.access_token = "" self.access_token = ""
# Logging Settings """access token for OAuth/Bearer
"""
self.logger = {} self.logger = {}
"""Logging Settings
"""
self.logger["package_logger"] = logging.getLogger("petstore_api") self.logger["package_logger"] = logging.getLogger("petstore_api")
self.logger["urllib3_logger"] = logging.getLogger("urllib3") self.logger["urllib3_logger"] = logging.getLogger("urllib3")
# Log format
self.logger_format = '%(asctime)s %(levelname)s %(message)s' self.logger_format = '%(asctime)s %(levelname)s %(message)s'
# Log stream handler """Log format
"""
self.logger_stream_handler = None self.logger_stream_handler = None
# Log file handler """Log stream handler
"""
self.logger_file_handler = None self.logger_file_handler = None
# Debug file location """Log file handler
"""
self.logger_file = None self.logger_file = None
# Debug switch """Debug file location
"""
self.debug = False self.debug = False
"""Debug switch
"""
# SSL/TLS verification
# Set this to false to skip verifying SSL certificate when calling API
# from https server.
self.verify_ssl = True self.verify_ssl = True
# Set this to customize the certificate file to verify the peer. """SSL/TLS verification
Set this to false to skip verifying SSL certificate when calling API
from https server.
"""
self.ssl_ca_cert = None self.ssl_ca_cert = None
# client certificate file """Set this to customize the certificate file to verify the peer.
"""
self.cert_file = None self.cert_file = None
# client key file """client certificate file
"""
self.key_file = None self.key_file = None
# Set this to True/False to enable/disable SSL hostname verification. """client key file
"""
self.assert_hostname = None self.assert_hostname = None
"""Set this to True/False to enable/disable SSL hostname verification.
"""
# urllib3 connection pool's maximum number of connections saved
# per pool. urllib3 uses 1 connection as default value, but this is
# not the best value when you are making a lot of possibly parallel
# requests to the same host, which is often the case here.
# cpu_count * 5 is used as default value to increase performance.
self.connection_pool_maxsize = multiprocessing.cpu_count() * 5 self.connection_pool_maxsize = multiprocessing.cpu_count() * 5
"""urllib3 connection pool's maximum number of connections saved
per pool. urllib3 uses 1 connection as default value, but this is
not the best value when you are making a lot of possibly parallel
requests to the same host, which is often the case here.
cpu_count * 5 is used as default value to increase performance.
"""
# Proxy URL
self.proxy = None self.proxy = None
# Proxy headers """Proxy URL
"""
self.proxy_headers = None self.proxy_headers = None
# Safe chars for path_param """Proxy headers
"""
self.safe_chars_for_path_param = '' self.safe_chars_for_path_param = ''
# Adding retries to override urllib3 default value 3 """Safe chars for path_param
"""
self.retries = None self.retries = None
"""Adding retries to override urllib3 default value 3
"""
@property @property
def logger_file(self): def logger_file(self):

5
samples/client/petstore/python-tornado/docs/AnotherFakeApi.md
View File

@@ -54,5 +54,10 @@ No authorization required
- **Content-Type**: application/json - **Content-Type**: application/json
- **Accept**: application/json - **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
[[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)

67
samples/client/petstore/python-tornado/docs/FakeApi.md
View File

@@ -65,6 +65,11 @@ No authorization required
- **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 - **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
[[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)
# **fake_outer_boolean_serialize** # **fake_outer_boolean_serialize**
@@ -113,6 +118,11 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: */* - **Accept**: */*
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Output boolean | - |
[[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)
# **fake_outer_composite_serialize** # **fake_outer_composite_serialize**
@@ -161,6 +171,11 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: */* - **Accept**: */*
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Output composite | - |
[[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)
# **fake_outer_number_serialize** # **fake_outer_number_serialize**
@@ -209,6 +224,11 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: */* - **Accept**: */*
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Output number | - |
[[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)
# **fake_outer_string_serialize** # **fake_outer_string_serialize**
@@ -257,6 +277,11 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: */* - **Accept**: */*
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Output string | - |
[[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)
# **test_body_with_file_schema** # **test_body_with_file_schema**
@@ -304,6 +329,11 @@ No authorization required
- **Content-Type**: application/json - **Content-Type**: application/json
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Success | - |
[[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)
# **test_body_with_query_params** # **test_body_with_query_params**
@@ -351,6 +381,11 @@ No authorization required
- **Content-Type**: application/json - **Content-Type**: application/json
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Success | - |
[[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)
# **test_client_model** # **test_client_model**
@@ -400,6 +435,11 @@ No authorization required
- **Content-Type**: application/json - **Content-Type**: application/json
- **Accept**: application/json - **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
[[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)
# **test_endpoint_parameters** # **test_endpoint_parameters**
@@ -479,6 +519,12 @@ void (empty response body)
- **Content-Type**: application/x-www-form-urlencoded - **Content-Type**: application/x-www-form-urlencoded
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**400** | Invalid username supplied | - |
**404** | User not found | - |
[[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)
# **test_enum_parameters** # **test_enum_parameters**
@@ -541,6 +587,12 @@ No authorization required
- **Content-Type**: application/x-www-form-urlencoded - **Content-Type**: application/x-www-form-urlencoded
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**400** | Invalid request | - |
**404** | Not found | - |
[[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)
# **test_group_parameters** # **test_group_parameters**
@@ -599,6 +651,11 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**400** | Someting wrong | - |
[[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)
# **test_inline_additional_properties** # **test_inline_additional_properties**
@@ -645,6 +702,11 @@ No authorization required
- **Content-Type**: application/json - **Content-Type**: application/json
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
[[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)
# **test_json_form_data** # **test_json_form_data**
@@ -693,5 +755,10 @@ No authorization required
- **Content-Type**: application/x-www-form-urlencoded - **Content-Type**: application/x-www-form-urlencoded
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
[[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)

5
samples/client/petstore/python-tornado/docs/FakeClassnameTags123Api.md
View File

@@ -60,5 +60,10 @@ Name | Type | Description | Notes
- **Content-Type**: application/json - **Content-Type**: application/json
- **Accept**: application/json - **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
[[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)

54
samples/client/petstore/python-tornado/docs/PetApi.md
View File

@@ -63,6 +63,12 @@ void (empty response body)
- **Content-Type**: application/json, application/xml - **Content-Type**: application/json, application/xml
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
**405** | Invalid input | - |
[[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_pet** # **delete_pet**
@@ -115,6 +121,12 @@ void (empty response body)
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
**400** | Invalid pet value | - |
[[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)
# **find_pets_by_status** # **find_pets_by_status**
@@ -168,6 +180,12 @@ Name | Type | Description | Notes
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/xml, application/json - **Accept**: application/xml, application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
**400** | Invalid status value | - |
[[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)
# **find_pets_by_tags** # **find_pets_by_tags**
@@ -221,6 +239,12 @@ Name | Type | Description | Notes
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/xml, application/json - **Accept**: application/xml, application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
**400** | Invalid tag value | - |
[[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_pet_by_id** # **get_pet_by_id**
@@ -276,6 +300,13 @@ Name | Type | Description | Notes
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/xml, application/json - **Accept**: application/xml, application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
**400** | Invalid ID supplied | - |
**404** | Pet not found | - |
[[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)
# **update_pet** # **update_pet**
@@ -326,6 +357,14 @@ void (empty response body)
- **Content-Type**: application/json, application/xml - **Content-Type**: application/json, application/xml
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
**400** | Invalid ID supplied | - |
**404** | Pet not found | - |
**405** | Validation exception | - |
[[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)
# **update_pet_with_form** # **update_pet_with_form**
@@ -380,6 +419,11 @@ void (empty response body)
- **Content-Type**: application/x-www-form-urlencoded - **Content-Type**: application/x-www-form-urlencoded
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**405** | Invalid input | - |
[[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)
# **upload_file** # **upload_file**
@@ -435,6 +479,11 @@ Name | Type | Description | Notes
- **Content-Type**: multipart/form-data - **Content-Type**: multipart/form-data
- **Accept**: application/json - **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
[[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)
# **upload_file_with_required_file** # **upload_file_with_required_file**
@@ -490,5 +539,10 @@ Name | Type | Description | Notes
- **Content-Type**: multipart/form-data - **Content-Type**: multipart/form-data
- **Accept**: application/json - **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
[[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)

24
samples/client/petstore/python-tornado/docs/StoreApi.md
View File

@@ -56,6 +56,12 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**400** | Invalid ID supplied | - |
**404** | Order not found | - |
[[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_inventory** # **get_inventory**
@@ -107,6 +113,11 @@ This endpoint does not need any parameter.
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/json - **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
[[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_order_by_id** # **get_order_by_id**
@@ -156,6 +167,13 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/xml, application/json - **Accept**: application/xml, application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
**400** | Invalid ID supplied | - |
**404** | Order not found | - |
[[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)
# **place_order** # **place_order**
@@ -203,5 +221,11 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/xml, application/json - **Accept**: application/xml, application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
**400** | Invalid Order | - |
[[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)

45
samples/client/petstore/python-tornado/docs/UserApi.md
View File

@@ -60,6 +60,11 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**0** | successful operation | - |
[[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_users_with_array_input** # **create_users_with_array_input**
@@ -106,6 +111,11 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**0** | successful operation | - |
[[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_users_with_list_input** # **create_users_with_list_input**
@@ -152,6 +162,11 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**0** | successful operation | - |
[[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_user** # **delete_user**
@@ -200,6 +215,12 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**400** | Invalid username supplied | - |
**404** | User not found | - |
[[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_user_by_name** # **get_user_by_name**
@@ -247,6 +268,13 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/xml, application/json - **Accept**: application/xml, application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
**400** | Invalid username supplied | - |
**404** | User not found | - |
[[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)
# **login_user** # **login_user**
@@ -296,6 +324,12 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/xml, application/json - **Accept**: application/xml, application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | * X-Rate-Limit - calls per hour allowed by the user <br> * X-Expires-After - date in UTC when token expires <br> |
**400** | Invalid username/password supplied | - |
[[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)
# **logout_user** # **logout_user**
@@ -338,6 +372,11 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**0** | successful operation | - |
[[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)
# **update_user** # **update_user**
@@ -388,5 +427,11 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**400** | Invalid user supplied | - |
**404** | User not found | - |
[[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)

22
samples/client/petstore/python-tornado/petstore_api/api/another_fake_api.py
View File

@@ -45,8 +45,15 @@ class AnotherFakeApi(object):
>>> thread = api.call_123_test_special_tags(body, async_req=True) >>> thread = api.call_123_test_special_tags(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Client body: client model (required) :param Client body: client model (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: Client :return: Client
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -63,9 +70,18 @@ class AnotherFakeApi(object):
>>> thread = api.call_123_test_special_tags_with_http_info(body, async_req=True) >>> thread = api.call_123_test_special_tags_with_http_info(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Client body: client model (required) :param Client body: client model (required)
:return: Client :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(Client, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """

270
samples/client/petstore/python-tornado/petstore_api/api/fake_api.py
View File

@@ -45,8 +45,15 @@ class FakeApi(object):
>>> thread = api.create_xml_item(xml_item, async_req=True) >>> thread = api.create_xml_item(xml_item, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param XmlItem xml_item: XmlItem Body (required) :param XmlItem xml_item: XmlItem Body (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -63,8 +70,17 @@ class FakeApi(object):
>>> thread = api.create_xml_item_with_http_info(xml_item, async_req=True) >>> thread = api.create_xml_item_with_http_info(xml_item, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param XmlItem xml_item: XmlItem Body (required) :param XmlItem xml_item: XmlItem Body (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -137,8 +153,15 @@ class FakeApi(object):
>>> thread = api.fake_outer_boolean_serialize(async_req=True) >>> thread = api.fake_outer_boolean_serialize(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param bool body: Input boolean as post body :param bool body: Input boolean as post body
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: bool :return: bool
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -155,9 +178,18 @@ class FakeApi(object):
>>> thread = api.fake_outer_boolean_serialize_with_http_info(async_req=True) >>> thread = api.fake_outer_boolean_serialize_with_http_info(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param bool body: Input boolean as post body :param bool body: Input boolean as post body
:return: bool :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(bool, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -225,8 +257,15 @@ class FakeApi(object):
>>> thread = api.fake_outer_composite_serialize(async_req=True) >>> thread = api.fake_outer_composite_serialize(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param OuterComposite body: Input composite as post body :param OuterComposite body: Input composite as post body
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: OuterComposite :return: OuterComposite
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -243,9 +282,18 @@ class FakeApi(object):
>>> thread = api.fake_outer_composite_serialize_with_http_info(async_req=True) >>> thread = api.fake_outer_composite_serialize_with_http_info(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param OuterComposite body: Input composite as post body :param OuterComposite body: Input composite as post body
:return: OuterComposite :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(OuterComposite, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -313,8 +361,15 @@ class FakeApi(object):
>>> thread = api.fake_outer_number_serialize(async_req=True) >>> thread = api.fake_outer_number_serialize(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param float body: Input number as post body :param float body: Input number as post body
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: float :return: float
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -331,9 +386,18 @@ class FakeApi(object):
>>> thread = api.fake_outer_number_serialize_with_http_info(async_req=True) >>> thread = api.fake_outer_number_serialize_with_http_info(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param float body: Input number as post body :param float body: Input number as post body
:return: float :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(float, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -401,8 +465,15 @@ class FakeApi(object):
>>> thread = api.fake_outer_string_serialize(async_req=True) >>> thread = api.fake_outer_string_serialize(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str body: Input string as post body :param str body: Input string as post body
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: str :return: str
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -419,9 +490,18 @@ class FakeApi(object):
>>> thread = api.fake_outer_string_serialize_with_http_info(async_req=True) >>> thread = api.fake_outer_string_serialize_with_http_info(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str body: Input string as post body :param str body: Input string as post body
:return: str :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(str, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -489,8 +569,15 @@ class FakeApi(object):
>>> thread = api.test_body_with_file_schema(body, async_req=True) >>> thread = api.test_body_with_file_schema(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param FileSchemaTestClass body: (required) :param FileSchemaTestClass body: (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -507,8 +594,17 @@ class FakeApi(object):
>>> thread = api.test_body_with_file_schema_with_http_info(body, async_req=True) >>> thread = api.test_body_with_file_schema_with_http_info(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param FileSchemaTestClass body: (required) :param FileSchemaTestClass body: (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -580,9 +676,16 @@ class FakeApi(object):
>>> thread = api.test_body_with_query_params(query, body, async_req=True) >>> thread = api.test_body_with_query_params(query, body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str query: (required) :param str query: (required)
:param User body: (required) :param User body: (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -598,9 +701,18 @@ class FakeApi(object):
>>> thread = api.test_body_with_query_params_with_http_info(query, body, async_req=True) >>> thread = api.test_body_with_query_params_with_http_info(query, body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str query: (required) :param str query: (required)
:param User body: (required) :param User body: (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -679,8 +791,15 @@ class FakeApi(object):
>>> thread = api.test_client_model(body, async_req=True) >>> thread = api.test_client_model(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Client body: client model (required) :param Client body: client model (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: Client :return: Client
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -697,9 +816,18 @@ class FakeApi(object):
>>> thread = api.test_client_model_with_http_info(body, async_req=True) >>> thread = api.test_client_model_with_http_info(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Client body: client model (required) :param Client body: client model (required)
:return: Client :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(Client, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -775,7 +903,7 @@ class FakeApi(object):
>>> thread = api.test_endpoint_parameters(number, double, pattern_without_delimiter, byte, async_req=True) >>> thread = api.test_endpoint_parameters(number, double, pattern_without_delimiter, byte, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param float number: None (required) :param float number: None (required)
:param float double: None (required) :param float double: None (required)
:param str pattern_without_delimiter: None (required) :param str pattern_without_delimiter: None (required)
@@ -790,6 +918,13 @@ class FakeApi(object):
:param datetime date_time: None :param datetime date_time: None
:param str password: None :param str password: None
:param str param_callback: None :param str param_callback: None
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -806,7 +941,7 @@ class FakeApi(object):
>>> thread = api.test_endpoint_parameters_with_http_info(number, double, pattern_without_delimiter, byte, async_req=True) >>> thread = api.test_endpoint_parameters_with_http_info(number, double, pattern_without_delimiter, byte, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param float number: None (required) :param float number: None (required)
:param float double: None (required) :param float double: None (required)
:param str pattern_without_delimiter: None (required) :param str pattern_without_delimiter: None (required)
@@ -821,6 +956,15 @@ class FakeApi(object):
:param datetime date_time: None :param datetime date_time: None
:param str password: None :param str password: None
:param str param_callback: None :param str param_callback: None
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -959,7 +1103,7 @@ class FakeApi(object):
>>> thread = api.test_enum_parameters(async_req=True) >>> thread = api.test_enum_parameters(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param list[str] enum_header_string_array: Header parameter enum test (string array) :param list[str] enum_header_string_array: Header parameter enum test (string array)
:param str enum_header_string: Header parameter enum test (string) :param str enum_header_string: Header parameter enum test (string)
:param list[str] enum_query_string_array: Query parameter enum test (string array) :param list[str] enum_query_string_array: Query parameter enum test (string array)
@@ -968,6 +1112,13 @@ class FakeApi(object):
:param float enum_query_double: Query parameter enum test (double) :param float enum_query_double: Query parameter enum test (double)
:param list[str] enum_form_string_array: Form parameter enum test (string array) :param list[str] enum_form_string_array: Form parameter enum test (string array)
:param str enum_form_string: Form parameter enum test (string) :param str enum_form_string: Form parameter enum test (string)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -984,7 +1135,7 @@ class FakeApi(object):
>>> thread = api.test_enum_parameters_with_http_info(async_req=True) >>> thread = api.test_enum_parameters_with_http_info(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param list[str] enum_header_string_array: Header parameter enum test (string array) :param list[str] enum_header_string_array: Header parameter enum test (string array)
:param str enum_header_string: Header parameter enum test (string) :param str enum_header_string: Header parameter enum test (string)
:param list[str] enum_query_string_array: Query parameter enum test (string array) :param list[str] enum_query_string_array: Query parameter enum test (string array)
@@ -993,6 +1144,15 @@ class FakeApi(object):
:param float enum_query_double: Query parameter enum test (double) :param float enum_query_double: Query parameter enum test (double)
:param list[str] enum_form_string_array: Form parameter enum test (string array) :param list[str] enum_form_string_array: Form parameter enum test (string array)
:param str enum_form_string: Form parameter enum test (string) :param str enum_form_string: Form parameter enum test (string)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -1078,13 +1238,20 @@ class FakeApi(object):
>>> thread = api.test_group_parameters(required_string_group, required_boolean_group, required_int64_group, async_req=True) >>> thread = api.test_group_parameters(required_string_group, required_boolean_group, required_int64_group, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int required_string_group: Required String in group parameters (required) :param int required_string_group: Required String in group parameters (required)
:param bool required_boolean_group: Required Boolean in group parameters (required) :param bool required_boolean_group: Required Boolean in group parameters (required)
:param int required_int64_group: Required Integer in group parameters (required) :param int required_int64_group: Required Integer in group parameters (required)
:param int string_group: String in group parameters :param int string_group: String in group parameters
:param bool boolean_group: Boolean in group parameters :param bool boolean_group: Boolean in group parameters
:param int int64_group: Integer in group parameters :param int int64_group: Integer in group parameters
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -1101,13 +1268,22 @@ class FakeApi(object):
>>> thread = api.test_group_parameters_with_http_info(required_string_group, required_boolean_group, required_int64_group, async_req=True) >>> thread = api.test_group_parameters_with_http_info(required_string_group, required_boolean_group, required_int64_group, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int required_string_group: Required String in group parameters (required) :param int required_string_group: Required String in group parameters (required)
:param bool required_boolean_group: Required Boolean in group parameters (required) :param bool required_boolean_group: Required Boolean in group parameters (required)
:param int required_int64_group: Required Integer in group parameters (required) :param int required_int64_group: Required Integer in group parameters (required)
:param int string_group: String in group parameters :param int string_group: String in group parameters
:param bool boolean_group: Boolean in group parameters :param bool boolean_group: Boolean in group parameters
:param int int64_group: Integer in group parameters :param int int64_group: Integer in group parameters
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -1193,8 +1369,15 @@ class FakeApi(object):
>>> thread = api.test_inline_additional_properties(param, async_req=True) >>> thread = api.test_inline_additional_properties(param, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param dict(str, str) param: request body (required) :param dict(str, str) param: request body (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -1210,8 +1393,17 @@ class FakeApi(object):
>>> thread = api.test_inline_additional_properties_with_http_info(param, async_req=True) >>> thread = api.test_inline_additional_properties_with_http_info(param, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param dict(str, str) param: request body (required) :param dict(str, str) param: request body (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -1283,9 +1475,16 @@ class FakeApi(object):
>>> thread = api.test_json_form_data(param, param2, async_req=True) >>> thread = api.test_json_form_data(param, param2, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str param: field1 (required) :param str param: field1 (required)
:param str param2: field2 (required) :param str param2: field2 (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -1301,9 +1500,18 @@ class FakeApi(object):
>>> thread = api.test_json_form_data_with_http_info(param, param2, async_req=True) >>> thread = api.test_json_form_data_with_http_info(param, param2, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str param: field1 (required) :param str param: field1 (required)
:param str param2: field2 (required) :param str param2: field2 (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.

22
samples/client/petstore/python-tornado/petstore_api/api/fake_classname_tags_123_api.py
View File

@@ -45,8 +45,15 @@ class FakeClassnameTags123Api(object):
>>> thread = api.test_classname(body, async_req=True) >>> thread = api.test_classname(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Client body: client model (required) :param Client body: client model (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: Client :return: Client
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -63,9 +70,18 @@ class FakeClassnameTags123Api(object):
>>> thread = api.test_classname_with_http_info(body, async_req=True) >>> thread = api.test_classname_with_http_info(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Client body: client model (required) :param Client body: client model (required)
:return: Client :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(Client, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """

190
samples/client/petstore/python-tornado/petstore_api/api/pet_api.py
View File

@@ -44,8 +44,15 @@ class PetApi(object):
>>> thread = api.add_pet(body, async_req=True) >>> thread = api.add_pet(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Pet body: Pet object that needs to be added to the store (required) :param Pet body: Pet object that needs to be added to the store (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -61,8 +68,17 @@ class PetApi(object):
>>> thread = api.add_pet_with_http_info(body, async_req=True) >>> thread = api.add_pet_with_http_info(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Pet body: Pet object that needs to be added to the store (required) :param Pet body: Pet object that needs to be added to the store (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -134,9 +150,16 @@ class PetApi(object):
>>> thread = api.delete_pet(pet_id, async_req=True) >>> thread = api.delete_pet(pet_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int pet_id: Pet id to delete (required) :param int pet_id: Pet id to delete (required)
:param str api_key: :param str api_key:
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -152,9 +175,18 @@ class PetApi(object):
>>> thread = api.delete_pet_with_http_info(pet_id, async_req=True) >>> thread = api.delete_pet_with_http_info(pet_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int pet_id: Pet id to delete (required) :param int pet_id: Pet id to delete (required)
:param str api_key: :param str api_key:
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -225,8 +257,15 @@ class PetApi(object):
>>> thread = api.find_pets_by_status(status, async_req=True) >>> thread = api.find_pets_by_status(status, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param list[str] status: Status values that need to be considered for filter (required) :param list[str] status: Status values that need to be considered for filter (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: list[Pet] :return: list[Pet]
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -243,9 +282,18 @@ class PetApi(object):
>>> thread = api.find_pets_by_status_with_http_info(status, async_req=True) >>> thread = api.find_pets_by_status_with_http_info(status, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param list[str] status: Status values that need to be considered for filter (required) :param list[str] status: Status values that need to be considered for filter (required)
:return: list[Pet] :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(list[Pet], status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -318,8 +366,15 @@ class PetApi(object):
>>> thread = api.find_pets_by_tags(tags, async_req=True) >>> thread = api.find_pets_by_tags(tags, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param list[str] tags: Tags to filter by (required) :param list[str] tags: Tags to filter by (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: list[Pet] :return: list[Pet]
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -336,9 +391,18 @@ class PetApi(object):
>>> thread = api.find_pets_by_tags_with_http_info(tags, async_req=True) >>> thread = api.find_pets_by_tags_with_http_info(tags, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param list[str] tags: Tags to filter by (required) :param list[str] tags: Tags to filter by (required)
:return: list[Pet] :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(list[Pet], status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -411,8 +475,15 @@ class PetApi(object):
>>> thread = api.get_pet_by_id(pet_id, async_req=True) >>> thread = api.get_pet_by_id(pet_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int pet_id: ID of pet to return (required) :param int pet_id: ID of pet to return (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: Pet :return: Pet
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -429,9 +500,18 @@ class PetApi(object):
>>> thread = api.get_pet_by_id_with_http_info(pet_id, async_req=True) >>> thread = api.get_pet_by_id_with_http_info(pet_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int pet_id: ID of pet to return (required) :param int pet_id: ID of pet to return (required)
:return: Pet :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(Pet, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -502,8 +582,15 @@ class PetApi(object):
>>> thread = api.update_pet(body, async_req=True) >>> thread = api.update_pet(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Pet body: Pet object that needs to be added to the store (required) :param Pet body: Pet object that needs to be added to the store (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -519,8 +606,17 @@ class PetApi(object):
>>> thread = api.update_pet_with_http_info(body, async_req=True) >>> thread = api.update_pet_with_http_info(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Pet body: Pet object that needs to be added to the store (required) :param Pet body: Pet object that needs to be added to the store (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -592,10 +688,17 @@ class PetApi(object):
>>> thread = api.update_pet_with_form(pet_id, async_req=True) >>> thread = api.update_pet_with_form(pet_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int pet_id: ID of pet that needs to be updated (required) :param int pet_id: ID of pet that needs to be updated (required)
:param str name: Updated name of the pet :param str name: Updated name of the pet
:param str status: Updated status of the pet :param str status: Updated status of the pet
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -611,10 +714,19 @@ class PetApi(object):
>>> thread = api.update_pet_with_form_with_http_info(pet_id, async_req=True) >>> thread = api.update_pet_with_form_with_http_info(pet_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int pet_id: ID of pet that needs to be updated (required) :param int pet_id: ID of pet that needs to be updated (required)
:param str name: Updated name of the pet :param str name: Updated name of the pet
:param str status: Updated status of the pet :param str status: Updated status of the pet
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -690,10 +802,17 @@ class PetApi(object):
>>> thread = api.upload_file(pet_id, async_req=True) >>> thread = api.upload_file(pet_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int pet_id: ID of pet to update (required) :param int pet_id: ID of pet to update (required)
:param str additional_metadata: Additional data to pass to server :param str additional_metadata: Additional data to pass to server
:param file file: file to upload :param file file: file to upload
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: ApiResponse :return: ApiResponse
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -709,11 +828,20 @@ class PetApi(object):
>>> thread = api.upload_file_with_http_info(pet_id, async_req=True) >>> thread = api.upload_file_with_http_info(pet_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int pet_id: ID of pet to update (required) :param int pet_id: ID of pet to update (required)
:param str additional_metadata: Additional data to pass to server :param str additional_metadata: Additional data to pass to server
:param file file: file to upload :param file file: file to upload
:return: ApiResponse :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(ApiResponse, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -792,10 +920,17 @@ class PetApi(object):
>>> thread = api.upload_file_with_required_file(pet_id, required_file, async_req=True) >>> thread = api.upload_file_with_required_file(pet_id, required_file, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int pet_id: ID of pet to update (required) :param int pet_id: ID of pet to update (required)
:param file required_file: file to upload (required) :param file required_file: file to upload (required)
:param str additional_metadata: Additional data to pass to server :param str additional_metadata: Additional data to pass to server
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: ApiResponse :return: ApiResponse
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -811,11 +946,20 @@ class PetApi(object):
>>> thread = api.upload_file_with_required_file_with_http_info(pet_id, required_file, async_req=True) >>> thread = api.upload_file_with_required_file_with_http_info(pet_id, required_file, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int pet_id: ID of pet to update (required) :param int pet_id: ID of pet to update (required)
:param file required_file: file to upload (required) :param file required_file: file to upload (required)
:param str additional_metadata: Additional data to pass to server :param str additional_metadata: Additional data to pass to server
:return: ApiResponse :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(ApiResponse, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """

86
samples/client/petstore/python-tornado/petstore_api/api/store_api.py
View File

@@ -45,8 +45,15 @@ class StoreApi(object):
>>> thread = api.delete_order(order_id, async_req=True) >>> thread = api.delete_order(order_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str order_id: ID of the order that needs to be deleted (required) :param str order_id: ID of the order that needs to be deleted (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -63,8 +70,17 @@ class StoreApi(object):
>>> thread = api.delete_order_with_http_info(order_id, async_req=True) >>> thread = api.delete_order_with_http_info(order_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str order_id: ID of the order that needs to be deleted (required) :param str order_id: ID of the order that needs to be deleted (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -133,7 +149,14 @@ class StoreApi(object):
>>> thread = api.get_inventory(async_req=True) >>> thread = api.get_inventory(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: dict(str, int) :return: dict(str, int)
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -150,8 +173,17 @@ class StoreApi(object):
>>> thread = api.get_inventory_with_http_info(async_req=True) >>> thread = api.get_inventory_with_http_info(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:return: dict(str, int) :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(dict(str, int), status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -217,8 +249,15 @@ class StoreApi(object):
>>> thread = api.get_order_by_id(order_id, async_req=True) >>> thread = api.get_order_by_id(order_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int order_id: ID of pet that needs to be fetched (required) :param int order_id: ID of pet that needs to be fetched (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: Order :return: Order
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -235,9 +274,18 @@ class StoreApi(object):
>>> thread = api.get_order_by_id_with_http_info(order_id, async_req=True) >>> thread = api.get_order_by_id_with_http_info(order_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int order_id: ID of pet that needs to be fetched (required) :param int order_id: ID of pet that needs to be fetched (required)
:return: Order :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(Order, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -312,8 +360,15 @@ class StoreApi(object):
>>> thread = api.place_order(body, async_req=True) >>> thread = api.place_order(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Order body: order placed for purchasing the pet (required) :param Order body: order placed for purchasing the pet (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: Order :return: Order
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -329,9 +384,18 @@ class StoreApi(object):
>>> thread = api.place_order_with_http_info(body, async_req=True) >>> thread = api.place_order_with_http_info(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Order body: order placed for purchasing the pet (required) :param Order body: order placed for purchasing the pet (required)
:return: Order :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(Order, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """

164
samples/client/petstore/python-tornado/petstore_api/api/user_api.py
View File

@@ -45,8 +45,15 @@ class UserApi(object):
>>> thread = api.create_user(body, async_req=True) >>> thread = api.create_user(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param User body: Created user object (required) :param User body: Created user object (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -63,8 +70,17 @@ class UserApi(object):
>>> thread = api.create_user_with_http_info(body, async_req=True) >>> thread = api.create_user_with_http_info(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param User body: Created user object (required) :param User body: Created user object (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -132,8 +148,15 @@ class UserApi(object):
>>> thread = api.create_users_with_array_input(body, async_req=True) >>> thread = api.create_users_with_array_input(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param list[User] body: List of user object (required) :param list[User] body: List of user object (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -149,8 +172,17 @@ class UserApi(object):
>>> thread = api.create_users_with_array_input_with_http_info(body, async_req=True) >>> thread = api.create_users_with_array_input_with_http_info(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param list[User] body: List of user object (required) :param list[User] body: List of user object (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -218,8 +250,15 @@ class UserApi(object):
>>> thread = api.create_users_with_list_input(body, async_req=True) >>> thread = api.create_users_with_list_input(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param list[User] body: List of user object (required) :param list[User] body: List of user object (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -235,8 +274,17 @@ class UserApi(object):
>>> thread = api.create_users_with_list_input_with_http_info(body, async_req=True) >>> thread = api.create_users_with_list_input_with_http_info(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param list[User] body: List of user object (required) :param list[User] body: List of user object (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -305,8 +353,15 @@ class UserApi(object):
>>> thread = api.delete_user(username, async_req=True) >>> thread = api.delete_user(username, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str username: The name that needs to be deleted (required) :param str username: The name that needs to be deleted (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -323,8 +378,17 @@ class UserApi(object):
>>> thread = api.delete_user_with_http_info(username, async_req=True) >>> thread = api.delete_user_with_http_info(username, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str username: The name that needs to be deleted (required) :param str username: The name that needs to be deleted (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -392,8 +456,15 @@ class UserApi(object):
>>> thread = api.get_user_by_name(username, async_req=True) >>> thread = api.get_user_by_name(username, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str username: The name that needs to be fetched. Use user1 for testing. (required) :param str username: The name that needs to be fetched. Use user1 for testing. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: User :return: User
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -409,9 +480,18 @@ class UserApi(object):
>>> thread = api.get_user_by_name_with_http_info(username, async_req=True) >>> thread = api.get_user_by_name_with_http_info(username, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str username: The name that needs to be fetched. Use user1 for testing. (required) :param str username: The name that needs to be fetched. Use user1 for testing. (required)
:return: User :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(User, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -482,9 +562,16 @@ class UserApi(object):
>>> thread = api.login_user(username, password, async_req=True) >>> thread = api.login_user(username, password, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str username: The user name for login (required) :param str username: The user name for login (required)
:param str password: The password for login in clear text (required) :param str password: The password for login in clear text (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: str :return: str
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -500,10 +587,19 @@ class UserApi(object):
>>> thread = api.login_user_with_http_info(username, password, async_req=True) >>> thread = api.login_user_with_http_info(username, password, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str username: The user name for login (required) :param str username: The user name for login (required)
:param str password: The password for login in clear text (required) :param str password: The password for login in clear text (required)
:return: str :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(str, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -580,7 +676,14 @@ class UserApi(object):
>>> thread = api.logout_user(async_req=True) >>> thread = api.logout_user(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -596,7 +699,16 @@ class UserApi(object):
>>> thread = api.logout_user_with_http_info(async_req=True) >>> thread = api.logout_user_with_http_info(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -659,9 +771,16 @@ class UserApi(object):
>>> thread = api.update_user(username, body, async_req=True) >>> thread = api.update_user(username, body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str username: name that need to be deleted (required) :param str username: name that need to be deleted (required)
:param User body: Updated user object (required) :param User body: Updated user object (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -678,9 +797,18 @@ class UserApi(object):
>>> thread = api.update_user_with_http_info(username, body, async_req=True) >>> thread = api.update_user_with_http_info(username, body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str username: name that need to be deleted (required) :param str username: name that need to be deleted (required)
:param User body: Updated user object (required) :param User body: Updated user object (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.

109
samples/client/petstore/python-tornado/petstore_api/configuration.py
View File

@@ -27,9 +27,9 @@ class TypeWithDefault(type):
super(TypeWithDefault, cls).__init__(name, bases, dct) super(TypeWithDefault, cls).__init__(name, bases, dct)
cls._default = None cls._default = None
def __call__(cls): def __call__(cls, **kwargs):
if cls._default is None: if cls._default is None:
cls._default = type.__call__(cls) cls._default = type.__call__(cls, **kwargs)
return copy.copy(cls._default) return copy.copy(cls._default)
def set_default(cls, default): def set_default(cls, default):
@@ -41,69 +41,100 @@ class Configuration(six.with_metaclass(TypeWithDefault, object)):
Ref: https://openapi-generator.tech Ref: https://openapi-generator.tech
Do not edit the class manually. Do not edit the class manually.
:param host: Base url
:param api_key: Dict to store API key(s)
:param api_key_prefix: Dict to store API prefix (e.g. Bearer)
:param username: Username for HTTP basic authentication
:param password: Password for HTTP basic authentication
""" """
def __init__(self): def __init__(self, host="http://petstore.swagger.io:80/v2",
"""Constructor""" api_key={}, api_key_prefix={},
# Default Base url username="", password=""):
self.host = "http://petstore.swagger.io:80/v2" """Constructor
# Temp file folder for downloading files """
self.host = host
"""Default Base url
"""
self.temp_folder_path = None self.temp_folder_path = None
"""Temp file folder for downloading files
"""
# Authentication Settings # Authentication Settings
# dict to store API key(s) self.api_key = api_key
self.api_key = {} """dict to store API key(s)
# dict to store API prefix (e.g. Bearer) """
self.api_key_prefix = {} self.api_key_prefix = api_key_prefix
# Username for HTTP basic authentication """dict to store API prefix (e.g. Bearer)
self.username = "" """
# Password for HTTP basic authentication self.username = username
self.password = "" """Username for HTTP basic authentication
# access token for OAuth/Bearer """
self.password = password
"""Password for HTTP basic authentication
"""
self.access_token = "" self.access_token = ""
# Logging Settings """access token for OAuth/Bearer
"""
self.logger = {} self.logger = {}
"""Logging Settings
"""
self.logger["package_logger"] = logging.getLogger("petstore_api") self.logger["package_logger"] = logging.getLogger("petstore_api")
self.logger["urllib3_logger"] = logging.getLogger("urllib3") self.logger["urllib3_logger"] = logging.getLogger("urllib3")
# Log format
self.logger_format = '%(asctime)s %(levelname)s %(message)s' self.logger_format = '%(asctime)s %(levelname)s %(message)s'
# Log stream handler """Log format
"""
self.logger_stream_handler = None self.logger_stream_handler = None
# Log file handler """Log stream handler
"""
self.logger_file_handler = None self.logger_file_handler = None
# Debug file location """Log file handler
"""
self.logger_file = None self.logger_file = None
# Debug switch """Debug file location
"""
self.debug = False self.debug = False
"""Debug switch
"""
# SSL/TLS verification
# Set this to false to skip verifying SSL certificate when calling API
# from https server.
self.verify_ssl = True self.verify_ssl = True
# Set this to customize the certificate file to verify the peer. """SSL/TLS verification
Set this to false to skip verifying SSL certificate when calling API
from https server.
"""
self.ssl_ca_cert = None self.ssl_ca_cert = None
# client certificate file """Set this to customize the certificate file to verify the peer.
"""
self.cert_file = None self.cert_file = None
# client key file """client certificate file
"""
self.key_file = None self.key_file = None
# Set this to True/False to enable/disable SSL hostname verification. """client key file
"""
self.assert_hostname = None self.assert_hostname = None
"""Set this to True/False to enable/disable SSL hostname verification.
"""
# urllib3 connection pool's maximum number of connections saved
# per pool. urllib3 uses 1 connection as default value, but this is
# not the best value when you are making a lot of possibly parallel
# requests to the same host, which is often the case here.
# cpu_count * 5 is used as default value to increase performance.
self.connection_pool_maxsize = multiprocessing.cpu_count() * 5 self.connection_pool_maxsize = multiprocessing.cpu_count() * 5
"""urllib3 connection pool's maximum number of connections saved
per pool. urllib3 uses 1 connection as default value, but this is
not the best value when you are making a lot of possibly parallel
requests to the same host, which is often the case here.
cpu_count * 5 is used as default value to increase performance.
"""
# Proxy URL
self.proxy = None self.proxy = None
# Proxy headers """Proxy URL
"""
self.proxy_headers = None self.proxy_headers = None
# Safe chars for path_param """Proxy headers
"""
self.safe_chars_for_path_param = '' self.safe_chars_for_path_param = ''
# Adding retries to override urllib3 default value 3 """Safe chars for path_param
"""
self.retries = None self.retries = None
"""Adding retries to override urllib3 default value 3
"""
@property @property
def logger_file(self): def logger_file(self):

5
samples/client/petstore/python/docs/AnotherFakeApi.md
View File

@@ -54,5 +54,10 @@ No authorization required
- **Content-Type**: application/json - **Content-Type**: application/json
- **Accept**: application/json - **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
[[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)

67
samples/client/petstore/python/docs/FakeApi.md
View File

@@ -65,6 +65,11 @@ No authorization required
- **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 - **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
[[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)
# **fake_outer_boolean_serialize** # **fake_outer_boolean_serialize**
@@ -113,6 +118,11 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: */* - **Accept**: */*
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Output boolean | - |
[[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)
# **fake_outer_composite_serialize** # **fake_outer_composite_serialize**
@@ -161,6 +171,11 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: */* - **Accept**: */*
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Output composite | - |
[[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)
# **fake_outer_number_serialize** # **fake_outer_number_serialize**
@@ -209,6 +224,11 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: */* - **Accept**: */*
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Output number | - |
[[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)
# **fake_outer_string_serialize** # **fake_outer_string_serialize**
@@ -257,6 +277,11 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: */* - **Accept**: */*
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Output string | - |
[[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)
# **test_body_with_file_schema** # **test_body_with_file_schema**
@@ -304,6 +329,11 @@ No authorization required
- **Content-Type**: application/json - **Content-Type**: application/json
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Success | - |
[[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)
# **test_body_with_query_params** # **test_body_with_query_params**
@@ -351,6 +381,11 @@ No authorization required
- **Content-Type**: application/json - **Content-Type**: application/json
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Success | - |
[[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)
# **test_client_model** # **test_client_model**
@@ -400,6 +435,11 @@ No authorization required
- **Content-Type**: application/json - **Content-Type**: application/json
- **Accept**: application/json - **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
[[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)
# **test_endpoint_parameters** # **test_endpoint_parameters**
@@ -479,6 +519,12 @@ void (empty response body)
- **Content-Type**: application/x-www-form-urlencoded - **Content-Type**: application/x-www-form-urlencoded
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**400** | Invalid username supplied | - |
**404** | User not found | - |
[[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)
# **test_enum_parameters** # **test_enum_parameters**
@@ -541,6 +587,12 @@ No authorization required
- **Content-Type**: application/x-www-form-urlencoded - **Content-Type**: application/x-www-form-urlencoded
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**400** | Invalid request | - |
**404** | Not found | - |
[[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)
# **test_group_parameters** # **test_group_parameters**
@@ -599,6 +651,11 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**400** | Someting wrong | - |
[[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)
# **test_inline_additional_properties** # **test_inline_additional_properties**
@@ -645,6 +702,11 @@ No authorization required
- **Content-Type**: application/json - **Content-Type**: application/json
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
[[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)
# **test_json_form_data** # **test_json_form_data**
@@ -693,5 +755,10 @@ No authorization required
- **Content-Type**: application/x-www-form-urlencoded - **Content-Type**: application/x-www-form-urlencoded
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
[[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)

5
samples/client/petstore/python/docs/FakeClassnameTags123Api.md
View File

@@ -60,5 +60,10 @@ Name | Type | Description | Notes
- **Content-Type**: application/json - **Content-Type**: application/json
- **Accept**: application/json - **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
[[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)

54
samples/client/petstore/python/docs/PetApi.md
View File

@@ -63,6 +63,12 @@ void (empty response body)
- **Content-Type**: application/json, application/xml - **Content-Type**: application/json, application/xml
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
**405** | Invalid input | - |
[[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_pet** # **delete_pet**
@@ -115,6 +121,12 @@ void (empty response body)
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
**400** | Invalid pet value | - |
[[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)
# **find_pets_by_status** # **find_pets_by_status**
@@ -168,6 +180,12 @@ Name | Type | Description | Notes
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/xml, application/json - **Accept**: application/xml, application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
**400** | Invalid status value | - |
[[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)
# **find_pets_by_tags** # **find_pets_by_tags**
@@ -221,6 +239,12 @@ Name | Type | Description | Notes
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/xml, application/json - **Accept**: application/xml, application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
**400** | Invalid tag value | - |
[[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_pet_by_id** # **get_pet_by_id**
@@ -276,6 +300,13 @@ Name | Type | Description | Notes
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/xml, application/json - **Accept**: application/xml, application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
**400** | Invalid ID supplied | - |
**404** | Pet not found | - |
[[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)
# **update_pet** # **update_pet**
@@ -326,6 +357,14 @@ void (empty response body)
- **Content-Type**: application/json, application/xml - **Content-Type**: application/json, application/xml
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
**400** | Invalid ID supplied | - |
**404** | Pet not found | - |
**405** | Validation exception | - |
[[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)
# **update_pet_with_form** # **update_pet_with_form**
@@ -380,6 +419,11 @@ void (empty response body)
- **Content-Type**: application/x-www-form-urlencoded - **Content-Type**: application/x-www-form-urlencoded
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**405** | Invalid input | - |
[[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)
# **upload_file** # **upload_file**
@@ -435,6 +479,11 @@ Name | Type | Description | Notes
- **Content-Type**: multipart/form-data - **Content-Type**: multipart/form-data
- **Accept**: application/json - **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
[[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)
# **upload_file_with_required_file** # **upload_file_with_required_file**
@@ -490,5 +539,10 @@ Name | Type | Description | Notes
- **Content-Type**: multipart/form-data - **Content-Type**: multipart/form-data
- **Accept**: application/json - **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
[[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)

24
samples/client/petstore/python/docs/StoreApi.md
View File

@@ -56,6 +56,12 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**400** | Invalid ID supplied | - |
**404** | Order not found | - |
[[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_inventory** # **get_inventory**
@@ -107,6 +113,11 @@ This endpoint does not need any parameter.
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/json - **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
[[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_order_by_id** # **get_order_by_id**
@@ -156,6 +167,13 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/xml, application/json - **Accept**: application/xml, application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
**400** | Invalid ID supplied | - |
**404** | Order not found | - |
[[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)
# **place_order** # **place_order**
@@ -203,5 +221,11 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/xml, application/json - **Accept**: application/xml, application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
**400** | Invalid Order | - |
[[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)

45
samples/client/petstore/python/docs/UserApi.md
View File

@@ -60,6 +60,11 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**0** | successful operation | - |
[[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_users_with_array_input** # **create_users_with_array_input**
@@ -106,6 +111,11 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**0** | successful operation | - |
[[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_users_with_list_input** # **create_users_with_list_input**
@@ -152,6 +162,11 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**0** | successful operation | - |
[[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_user** # **delete_user**
@@ -200,6 +215,12 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**400** | Invalid username supplied | - |
**404** | User not found | - |
[[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_user_by_name** # **get_user_by_name**
@@ -247,6 +268,13 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/xml, application/json - **Accept**: application/xml, application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
**400** | Invalid username supplied | - |
**404** | User not found | - |
[[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)
# **login_user** # **login_user**
@@ -296,6 +324,12 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/xml, application/json - **Accept**: application/xml, application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | * X-Rate-Limit - calls per hour allowed by the user <br> * X-Expires-After - date in UTC when token expires <br> |
**400** | Invalid username/password supplied | - |
[[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)
# **logout_user** # **logout_user**
@@ -338,6 +372,11 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**0** | successful operation | - |
[[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)
# **update_user** # **update_user**
@@ -388,5 +427,11 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**400** | Invalid user supplied | - |
**404** | User not found | - |
[[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)

22
samples/client/petstore/python/petstore_api/api/another_fake_api.py
View File

@@ -45,8 +45,15 @@ class AnotherFakeApi(object):
>>> thread = api.call_123_test_special_tags(body, async_req=True) >>> thread = api.call_123_test_special_tags(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Client body: client model (required) :param Client body: client model (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: Client :return: Client
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -63,9 +70,18 @@ class AnotherFakeApi(object):
>>> thread = api.call_123_test_special_tags_with_http_info(body, async_req=True) >>> thread = api.call_123_test_special_tags_with_http_info(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Client body: client model (required) :param Client body: client model (required)
:return: Client :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(Client, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """

270
samples/client/petstore/python/petstore_api/api/fake_api.py
View File

@@ -45,8 +45,15 @@ class FakeApi(object):
>>> thread = api.create_xml_item(xml_item, async_req=True) >>> thread = api.create_xml_item(xml_item, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param XmlItem xml_item: XmlItem Body (required) :param XmlItem xml_item: XmlItem Body (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -63,8 +70,17 @@ class FakeApi(object):
>>> thread = api.create_xml_item_with_http_info(xml_item, async_req=True) >>> thread = api.create_xml_item_with_http_info(xml_item, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param XmlItem xml_item: XmlItem Body (required) :param XmlItem xml_item: XmlItem Body (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -137,8 +153,15 @@ class FakeApi(object):
>>> thread = api.fake_outer_boolean_serialize(async_req=True) >>> thread = api.fake_outer_boolean_serialize(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param bool body: Input boolean as post body :param bool body: Input boolean as post body
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: bool :return: bool
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -155,9 +178,18 @@ class FakeApi(object):
>>> thread = api.fake_outer_boolean_serialize_with_http_info(async_req=True) >>> thread = api.fake_outer_boolean_serialize_with_http_info(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param bool body: Input boolean as post body :param bool body: Input boolean as post body
:return: bool :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(bool, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -225,8 +257,15 @@ class FakeApi(object):
>>> thread = api.fake_outer_composite_serialize(async_req=True) >>> thread = api.fake_outer_composite_serialize(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param OuterComposite body: Input composite as post body :param OuterComposite body: Input composite as post body
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: OuterComposite :return: OuterComposite
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -243,9 +282,18 @@ class FakeApi(object):
>>> thread = api.fake_outer_composite_serialize_with_http_info(async_req=True) >>> thread = api.fake_outer_composite_serialize_with_http_info(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param OuterComposite body: Input composite as post body :param OuterComposite body: Input composite as post body
:return: OuterComposite :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(OuterComposite, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -313,8 +361,15 @@ class FakeApi(object):
>>> thread = api.fake_outer_number_serialize(async_req=True) >>> thread = api.fake_outer_number_serialize(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param float body: Input number as post body :param float body: Input number as post body
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: float :return: float
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -331,9 +386,18 @@ class FakeApi(object):
>>> thread = api.fake_outer_number_serialize_with_http_info(async_req=True) >>> thread = api.fake_outer_number_serialize_with_http_info(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param float body: Input number as post body :param float body: Input number as post body
:return: float :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(float, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -401,8 +465,15 @@ class FakeApi(object):
>>> thread = api.fake_outer_string_serialize(async_req=True) >>> thread = api.fake_outer_string_serialize(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str body: Input string as post body :param str body: Input string as post body
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: str :return: str
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -419,9 +490,18 @@ class FakeApi(object):
>>> thread = api.fake_outer_string_serialize_with_http_info(async_req=True) >>> thread = api.fake_outer_string_serialize_with_http_info(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str body: Input string as post body :param str body: Input string as post body
:return: str :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(str, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -489,8 +569,15 @@ class FakeApi(object):
>>> thread = api.test_body_with_file_schema(body, async_req=True) >>> thread = api.test_body_with_file_schema(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param FileSchemaTestClass body: (required) :param FileSchemaTestClass body: (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -507,8 +594,17 @@ class FakeApi(object):
>>> thread = api.test_body_with_file_schema_with_http_info(body, async_req=True) >>> thread = api.test_body_with_file_schema_with_http_info(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param FileSchemaTestClass body: (required) :param FileSchemaTestClass body: (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -580,9 +676,16 @@ class FakeApi(object):
>>> thread = api.test_body_with_query_params(query, body, async_req=True) >>> thread = api.test_body_with_query_params(query, body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str query: (required) :param str query: (required)
:param User body: (required) :param User body: (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -598,9 +701,18 @@ class FakeApi(object):
>>> thread = api.test_body_with_query_params_with_http_info(query, body, async_req=True) >>> thread = api.test_body_with_query_params_with_http_info(query, body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str query: (required) :param str query: (required)
:param User body: (required) :param User body: (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -679,8 +791,15 @@ class FakeApi(object):
>>> thread = api.test_client_model(body, async_req=True) >>> thread = api.test_client_model(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Client body: client model (required) :param Client body: client model (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: Client :return: Client
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -697,9 +816,18 @@ class FakeApi(object):
>>> thread = api.test_client_model_with_http_info(body, async_req=True) >>> thread = api.test_client_model_with_http_info(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Client body: client model (required) :param Client body: client model (required)
:return: Client :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(Client, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -775,7 +903,7 @@ class FakeApi(object):
>>> thread = api.test_endpoint_parameters(number, double, pattern_without_delimiter, byte, async_req=True) >>> thread = api.test_endpoint_parameters(number, double, pattern_without_delimiter, byte, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param float number: None (required) :param float number: None (required)
:param float double: None (required) :param float double: None (required)
:param str pattern_without_delimiter: None (required) :param str pattern_without_delimiter: None (required)
@@ -790,6 +918,13 @@ class FakeApi(object):
:param datetime date_time: None :param datetime date_time: None
:param str password: None :param str password: None
:param str param_callback: None :param str param_callback: None
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -806,7 +941,7 @@ class FakeApi(object):
>>> thread = api.test_endpoint_parameters_with_http_info(number, double, pattern_without_delimiter, byte, async_req=True) >>> thread = api.test_endpoint_parameters_with_http_info(number, double, pattern_without_delimiter, byte, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param float number: None (required) :param float number: None (required)
:param float double: None (required) :param float double: None (required)
:param str pattern_without_delimiter: None (required) :param str pattern_without_delimiter: None (required)
@@ -821,6 +956,15 @@ class FakeApi(object):
:param datetime date_time: None :param datetime date_time: None
:param str password: None :param str password: None
:param str param_callback: None :param str param_callback: None
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -959,7 +1103,7 @@ class FakeApi(object):
>>> thread = api.test_enum_parameters(async_req=True) >>> thread = api.test_enum_parameters(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param list[str] enum_header_string_array: Header parameter enum test (string array) :param list[str] enum_header_string_array: Header parameter enum test (string array)
:param str enum_header_string: Header parameter enum test (string) :param str enum_header_string: Header parameter enum test (string)
:param list[str] enum_query_string_array: Query parameter enum test (string array) :param list[str] enum_query_string_array: Query parameter enum test (string array)
@@ -968,6 +1112,13 @@ class FakeApi(object):
:param float enum_query_double: Query parameter enum test (double) :param float enum_query_double: Query parameter enum test (double)
:param list[str] enum_form_string_array: Form parameter enum test (string array) :param list[str] enum_form_string_array: Form parameter enum test (string array)
:param str enum_form_string: Form parameter enum test (string) :param str enum_form_string: Form parameter enum test (string)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -984,7 +1135,7 @@ class FakeApi(object):
>>> thread = api.test_enum_parameters_with_http_info(async_req=True) >>> thread = api.test_enum_parameters_with_http_info(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param list[str] enum_header_string_array: Header parameter enum test (string array) :param list[str] enum_header_string_array: Header parameter enum test (string array)
:param str enum_header_string: Header parameter enum test (string) :param str enum_header_string: Header parameter enum test (string)
:param list[str] enum_query_string_array: Query parameter enum test (string array) :param list[str] enum_query_string_array: Query parameter enum test (string array)
@@ -993,6 +1144,15 @@ class FakeApi(object):
:param float enum_query_double: Query parameter enum test (double) :param float enum_query_double: Query parameter enum test (double)
:param list[str] enum_form_string_array: Form parameter enum test (string array) :param list[str] enum_form_string_array: Form parameter enum test (string array)
:param str enum_form_string: Form parameter enum test (string) :param str enum_form_string: Form parameter enum test (string)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -1078,13 +1238,20 @@ class FakeApi(object):
>>> thread = api.test_group_parameters(required_string_group, required_boolean_group, required_int64_group, async_req=True) >>> thread = api.test_group_parameters(required_string_group, required_boolean_group, required_int64_group, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int required_string_group: Required String in group parameters (required) :param int required_string_group: Required String in group parameters (required)
:param bool required_boolean_group: Required Boolean in group parameters (required) :param bool required_boolean_group: Required Boolean in group parameters (required)
:param int required_int64_group: Required Integer in group parameters (required) :param int required_int64_group: Required Integer in group parameters (required)
:param int string_group: String in group parameters :param int string_group: String in group parameters
:param bool boolean_group: Boolean in group parameters :param bool boolean_group: Boolean in group parameters
:param int int64_group: Integer in group parameters :param int int64_group: Integer in group parameters
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -1101,13 +1268,22 @@ class FakeApi(object):
>>> thread = api.test_group_parameters_with_http_info(required_string_group, required_boolean_group, required_int64_group, async_req=True) >>> thread = api.test_group_parameters_with_http_info(required_string_group, required_boolean_group, required_int64_group, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int required_string_group: Required String in group parameters (required) :param int required_string_group: Required String in group parameters (required)
:param bool required_boolean_group: Required Boolean in group parameters (required) :param bool required_boolean_group: Required Boolean in group parameters (required)
:param int required_int64_group: Required Integer in group parameters (required) :param int required_int64_group: Required Integer in group parameters (required)
:param int string_group: String in group parameters :param int string_group: String in group parameters
:param bool boolean_group: Boolean in group parameters :param bool boolean_group: Boolean in group parameters
:param int int64_group: Integer in group parameters :param int int64_group: Integer in group parameters
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -1193,8 +1369,15 @@ class FakeApi(object):
>>> thread = api.test_inline_additional_properties(param, async_req=True) >>> thread = api.test_inline_additional_properties(param, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param dict(str, str) param: request body (required) :param dict(str, str) param: request body (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -1210,8 +1393,17 @@ class FakeApi(object):
>>> thread = api.test_inline_additional_properties_with_http_info(param, async_req=True) >>> thread = api.test_inline_additional_properties_with_http_info(param, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param dict(str, str) param: request body (required) :param dict(str, str) param: request body (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -1283,9 +1475,16 @@ class FakeApi(object):
>>> thread = api.test_json_form_data(param, param2, async_req=True) >>> thread = api.test_json_form_data(param, param2, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str param: field1 (required) :param str param: field1 (required)
:param str param2: field2 (required) :param str param2: field2 (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -1301,9 +1500,18 @@ class FakeApi(object):
>>> thread = api.test_json_form_data_with_http_info(param, param2, async_req=True) >>> thread = api.test_json_form_data_with_http_info(param, param2, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str param: field1 (required) :param str param: field1 (required)
:param str param2: field2 (required) :param str param2: field2 (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.

22
samples/client/petstore/python/petstore_api/api/fake_classname_tags_123_api.py
View File

@@ -45,8 +45,15 @@ class FakeClassnameTags123Api(object):
>>> thread = api.test_classname(body, async_req=True) >>> thread = api.test_classname(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Client body: client model (required) :param Client body: client model (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: Client :return: Client
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -63,9 +70,18 @@ class FakeClassnameTags123Api(object):
>>> thread = api.test_classname_with_http_info(body, async_req=True) >>> thread = api.test_classname_with_http_info(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Client body: client model (required) :param Client body: client model (required)
:return: Client :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(Client, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """

190
samples/client/petstore/python/petstore_api/api/pet_api.py
View File

@@ -44,8 +44,15 @@ class PetApi(object):
>>> thread = api.add_pet(body, async_req=True) >>> thread = api.add_pet(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Pet body: Pet object that needs to be added to the store (required) :param Pet body: Pet object that needs to be added to the store (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -61,8 +68,17 @@ class PetApi(object):
>>> thread = api.add_pet_with_http_info(body, async_req=True) >>> thread = api.add_pet_with_http_info(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Pet body: Pet object that needs to be added to the store (required) :param Pet body: Pet object that needs to be added to the store (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -134,9 +150,16 @@ class PetApi(object):
>>> thread = api.delete_pet(pet_id, async_req=True) >>> thread = api.delete_pet(pet_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int pet_id: Pet id to delete (required) :param int pet_id: Pet id to delete (required)
:param str api_key: :param str api_key:
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -152,9 +175,18 @@ class PetApi(object):
>>> thread = api.delete_pet_with_http_info(pet_id, async_req=True) >>> thread = api.delete_pet_with_http_info(pet_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int pet_id: Pet id to delete (required) :param int pet_id: Pet id to delete (required)
:param str api_key: :param str api_key:
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -225,8 +257,15 @@ class PetApi(object):
>>> thread = api.find_pets_by_status(status, async_req=True) >>> thread = api.find_pets_by_status(status, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param list[str] status: Status values that need to be considered for filter (required) :param list[str] status: Status values that need to be considered for filter (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: list[Pet] :return: list[Pet]
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -243,9 +282,18 @@ class PetApi(object):
>>> thread = api.find_pets_by_status_with_http_info(status, async_req=True) >>> thread = api.find_pets_by_status_with_http_info(status, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param list[str] status: Status values that need to be considered for filter (required) :param list[str] status: Status values that need to be considered for filter (required)
:return: list[Pet] :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(list[Pet], status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -318,8 +366,15 @@ class PetApi(object):
>>> thread = api.find_pets_by_tags(tags, async_req=True) >>> thread = api.find_pets_by_tags(tags, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param list[str] tags: Tags to filter by (required) :param list[str] tags: Tags to filter by (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: list[Pet] :return: list[Pet]
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -336,9 +391,18 @@ class PetApi(object):
>>> thread = api.find_pets_by_tags_with_http_info(tags, async_req=True) >>> thread = api.find_pets_by_tags_with_http_info(tags, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param list[str] tags: Tags to filter by (required) :param list[str] tags: Tags to filter by (required)
:return: list[Pet] :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(list[Pet], status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -411,8 +475,15 @@ class PetApi(object):
>>> thread = api.get_pet_by_id(pet_id, async_req=True) >>> thread = api.get_pet_by_id(pet_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int pet_id: ID of pet to return (required) :param int pet_id: ID of pet to return (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: Pet :return: Pet
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -429,9 +500,18 @@ class PetApi(object):
>>> thread = api.get_pet_by_id_with_http_info(pet_id, async_req=True) >>> thread = api.get_pet_by_id_with_http_info(pet_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int pet_id: ID of pet to return (required) :param int pet_id: ID of pet to return (required)
:return: Pet :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(Pet, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -502,8 +582,15 @@ class PetApi(object):
>>> thread = api.update_pet(body, async_req=True) >>> thread = api.update_pet(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Pet body: Pet object that needs to be added to the store (required) :param Pet body: Pet object that needs to be added to the store (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -519,8 +606,17 @@ class PetApi(object):
>>> thread = api.update_pet_with_http_info(body, async_req=True) >>> thread = api.update_pet_with_http_info(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Pet body: Pet object that needs to be added to the store (required) :param Pet body: Pet object that needs to be added to the store (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -592,10 +688,17 @@ class PetApi(object):
>>> thread = api.update_pet_with_form(pet_id, async_req=True) >>> thread = api.update_pet_with_form(pet_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int pet_id: ID of pet that needs to be updated (required) :param int pet_id: ID of pet that needs to be updated (required)
:param str name: Updated name of the pet :param str name: Updated name of the pet
:param str status: Updated status of the pet :param str status: Updated status of the pet
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -611,10 +714,19 @@ class PetApi(object):
>>> thread = api.update_pet_with_form_with_http_info(pet_id, async_req=True) >>> thread = api.update_pet_with_form_with_http_info(pet_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int pet_id: ID of pet that needs to be updated (required) :param int pet_id: ID of pet that needs to be updated (required)
:param str name: Updated name of the pet :param str name: Updated name of the pet
:param str status: Updated status of the pet :param str status: Updated status of the pet
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -690,10 +802,17 @@ class PetApi(object):
>>> thread = api.upload_file(pet_id, async_req=True) >>> thread = api.upload_file(pet_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int pet_id: ID of pet to update (required) :param int pet_id: ID of pet to update (required)
:param str additional_metadata: Additional data to pass to server :param str additional_metadata: Additional data to pass to server
:param file file: file to upload :param file file: file to upload
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: ApiResponse :return: ApiResponse
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -709,11 +828,20 @@ class PetApi(object):
>>> thread = api.upload_file_with_http_info(pet_id, async_req=True) >>> thread = api.upload_file_with_http_info(pet_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int pet_id: ID of pet to update (required) :param int pet_id: ID of pet to update (required)
:param str additional_metadata: Additional data to pass to server :param str additional_metadata: Additional data to pass to server
:param file file: file to upload :param file file: file to upload
:return: ApiResponse :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(ApiResponse, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -792,10 +920,17 @@ class PetApi(object):
>>> thread = api.upload_file_with_required_file(pet_id, required_file, async_req=True) >>> thread = api.upload_file_with_required_file(pet_id, required_file, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int pet_id: ID of pet to update (required) :param int pet_id: ID of pet to update (required)
:param file required_file: file to upload (required) :param file required_file: file to upload (required)
:param str additional_metadata: Additional data to pass to server :param str additional_metadata: Additional data to pass to server
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: ApiResponse :return: ApiResponse
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -811,11 +946,20 @@ class PetApi(object):
>>> thread = api.upload_file_with_required_file_with_http_info(pet_id, required_file, async_req=True) >>> thread = api.upload_file_with_required_file_with_http_info(pet_id, required_file, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int pet_id: ID of pet to update (required) :param int pet_id: ID of pet to update (required)
:param file required_file: file to upload (required) :param file required_file: file to upload (required)
:param str additional_metadata: Additional data to pass to server :param str additional_metadata: Additional data to pass to server
:return: ApiResponse :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(ApiResponse, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """

86
samples/client/petstore/python/petstore_api/api/store_api.py
View File

@@ -45,8 +45,15 @@ class StoreApi(object):
>>> thread = api.delete_order(order_id, async_req=True) >>> thread = api.delete_order(order_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str order_id: ID of the order that needs to be deleted (required) :param str order_id: ID of the order that needs to be deleted (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -63,8 +70,17 @@ class StoreApi(object):
>>> thread = api.delete_order_with_http_info(order_id, async_req=True) >>> thread = api.delete_order_with_http_info(order_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str order_id: ID of the order that needs to be deleted (required) :param str order_id: ID of the order that needs to be deleted (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -133,7 +149,14 @@ class StoreApi(object):
>>> thread = api.get_inventory(async_req=True) >>> thread = api.get_inventory(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: dict(str, int) :return: dict(str, int)
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -150,8 +173,17 @@ class StoreApi(object):
>>> thread = api.get_inventory_with_http_info(async_req=True) >>> thread = api.get_inventory_with_http_info(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:return: dict(str, int) :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(dict(str, int), status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -217,8 +249,15 @@ class StoreApi(object):
>>> thread = api.get_order_by_id(order_id, async_req=True) >>> thread = api.get_order_by_id(order_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int order_id: ID of pet that needs to be fetched (required) :param int order_id: ID of pet that needs to be fetched (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: Order :return: Order
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -235,9 +274,18 @@ class StoreApi(object):
>>> thread = api.get_order_by_id_with_http_info(order_id, async_req=True) >>> thread = api.get_order_by_id_with_http_info(order_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int order_id: ID of pet that needs to be fetched (required) :param int order_id: ID of pet that needs to be fetched (required)
:return: Order :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(Order, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -312,8 +360,15 @@ class StoreApi(object):
>>> thread = api.place_order(body, async_req=True) >>> thread = api.place_order(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Order body: order placed for purchasing the pet (required) :param Order body: order placed for purchasing the pet (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: Order :return: Order
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -329,9 +384,18 @@ class StoreApi(object):
>>> thread = api.place_order_with_http_info(body, async_req=True) >>> thread = api.place_order_with_http_info(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Order body: order placed for purchasing the pet (required) :param Order body: order placed for purchasing the pet (required)
:return: Order :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(Order, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """

164
samples/client/petstore/python/petstore_api/api/user_api.py
View File

@@ -45,8 +45,15 @@ class UserApi(object):
>>> thread = api.create_user(body, async_req=True) >>> thread = api.create_user(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param User body: Created user object (required) :param User body: Created user object (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -63,8 +70,17 @@ class UserApi(object):
>>> thread = api.create_user_with_http_info(body, async_req=True) >>> thread = api.create_user_with_http_info(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param User body: Created user object (required) :param User body: Created user object (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -132,8 +148,15 @@ class UserApi(object):
>>> thread = api.create_users_with_array_input(body, async_req=True) >>> thread = api.create_users_with_array_input(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param list[User] body: List of user object (required) :param list[User] body: List of user object (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -149,8 +172,17 @@ class UserApi(object):
>>> thread = api.create_users_with_array_input_with_http_info(body, async_req=True) >>> thread = api.create_users_with_array_input_with_http_info(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param list[User] body: List of user object (required) :param list[User] body: List of user object (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -218,8 +250,15 @@ class UserApi(object):
>>> thread = api.create_users_with_list_input(body, async_req=True) >>> thread = api.create_users_with_list_input(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param list[User] body: List of user object (required) :param list[User] body: List of user object (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -235,8 +274,17 @@ class UserApi(object):
>>> thread = api.create_users_with_list_input_with_http_info(body, async_req=True) >>> thread = api.create_users_with_list_input_with_http_info(body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param list[User] body: List of user object (required) :param list[User] body: List of user object (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -305,8 +353,15 @@ class UserApi(object):
>>> thread = api.delete_user(username, async_req=True) >>> thread = api.delete_user(username, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str username: The name that needs to be deleted (required) :param str username: The name that needs to be deleted (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -323,8 +378,17 @@ class UserApi(object):
>>> thread = api.delete_user_with_http_info(username, async_req=True) >>> thread = api.delete_user_with_http_info(username, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str username: The name that needs to be deleted (required) :param str username: The name that needs to be deleted (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -392,8 +456,15 @@ class UserApi(object):
>>> thread = api.get_user_by_name(username, async_req=True) >>> thread = api.get_user_by_name(username, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str username: The name that needs to be fetched. Use user1 for testing. (required) :param str username: The name that needs to be fetched. Use user1 for testing. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: User :return: User
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -409,9 +480,18 @@ class UserApi(object):
>>> thread = api.get_user_by_name_with_http_info(username, async_req=True) >>> thread = api.get_user_by_name_with_http_info(username, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str username: The name that needs to be fetched. Use user1 for testing. (required) :param str username: The name that needs to be fetched. Use user1 for testing. (required)
:return: User :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(User, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -482,9 +562,16 @@ class UserApi(object):
>>> thread = api.login_user(username, password, async_req=True) >>> thread = api.login_user(username, password, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str username: The user name for login (required) :param str username: The user name for login (required)
:param str password: The password for login in clear text (required) :param str password: The password for login in clear text (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: str :return: str
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -500,10 +587,19 @@ class UserApi(object):
>>> thread = api.login_user_with_http_info(username, password, async_req=True) >>> thread = api.login_user_with_http_info(username, password, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str username: The user name for login (required) :param str username: The user name for login (required)
:param str password: The password for login in clear text (required) :param str password: The password for login in clear text (required)
:return: str :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(str, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -580,7 +676,14 @@ class UserApi(object):
>>> thread = api.logout_user(async_req=True) >>> thread = api.logout_user(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -596,7 +699,16 @@ class UserApi(object):
>>> thread = api.logout_user_with_http_info(async_req=True) >>> thread = api.logout_user_with_http_info(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -659,9 +771,16 @@ class UserApi(object):
>>> thread = api.update_user(username, body, async_req=True) >>> thread = api.update_user(username, body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str username: name that need to be deleted (required) :param str username: name that need to be deleted (required)
:param User body: Updated user object (required) :param User body: Updated user object (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -678,9 +797,18 @@ class UserApi(object):
>>> thread = api.update_user_with_http_info(username, body, async_req=True) >>> thread = api.update_user_with_http_info(username, body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str username: name that need to be deleted (required) :param str username: name that need to be deleted (required)
:param User body: Updated user object (required) :param User body: Updated user object (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.

109
samples/client/petstore/python/petstore_api/configuration.py
View File

@@ -27,9 +27,9 @@ class TypeWithDefault(type):
super(TypeWithDefault, cls).__init__(name, bases, dct) super(TypeWithDefault, cls).__init__(name, bases, dct)
cls._default = None cls._default = None
def __call__(cls): def __call__(cls, **kwargs):
if cls._default is None: if cls._default is None:
cls._default = type.__call__(cls) cls._default = type.__call__(cls, **kwargs)
return copy.copy(cls._default) return copy.copy(cls._default)
def set_default(cls, default): def set_default(cls, default):
@@ -41,69 +41,100 @@ class Configuration(six.with_metaclass(TypeWithDefault, object)):
Ref: https://openapi-generator.tech Ref: https://openapi-generator.tech
Do not edit the class manually. Do not edit the class manually.
:param host: Base url
:param api_key: Dict to store API key(s)
:param api_key_prefix: Dict to store API prefix (e.g. Bearer)
:param username: Username for HTTP basic authentication
:param password: Password for HTTP basic authentication
""" """
def __init__(self): def __init__(self, host="http://petstore.swagger.io:80/v2",
"""Constructor""" api_key={}, api_key_prefix={},
# Default Base url username="", password=""):
self.host = "http://petstore.swagger.io:80/v2" """Constructor
# Temp file folder for downloading files """
self.host = host
"""Default Base url
"""
self.temp_folder_path = None self.temp_folder_path = None
"""Temp file folder for downloading files
"""
# Authentication Settings # Authentication Settings
# dict to store API key(s) self.api_key = api_key
self.api_key = {} """dict to store API key(s)
# dict to store API prefix (e.g. Bearer) """
self.api_key_prefix = {} self.api_key_prefix = api_key_prefix
# Username for HTTP basic authentication """dict to store API prefix (e.g. Bearer)
self.username = "" """
# Password for HTTP basic authentication self.username = username
self.password = "" """Username for HTTP basic authentication
# access token for OAuth/Bearer """
self.password = password
"""Password for HTTP basic authentication
"""
self.access_token = "" self.access_token = ""
# Logging Settings """access token for OAuth/Bearer
"""
self.logger = {} self.logger = {}
"""Logging Settings
"""
self.logger["package_logger"] = logging.getLogger("petstore_api") self.logger["package_logger"] = logging.getLogger("petstore_api")
self.logger["urllib3_logger"] = logging.getLogger("urllib3") self.logger["urllib3_logger"] = logging.getLogger("urllib3")
# Log format
self.logger_format = '%(asctime)s %(levelname)s %(message)s' self.logger_format = '%(asctime)s %(levelname)s %(message)s'
# Log stream handler """Log format
"""
self.logger_stream_handler = None self.logger_stream_handler = None
# Log file handler """Log stream handler
"""
self.logger_file_handler = None self.logger_file_handler = None
# Debug file location """Log file handler
"""
self.logger_file = None self.logger_file = None
# Debug switch """Debug file location
"""
self.debug = False self.debug = False
"""Debug switch
"""
# SSL/TLS verification
# Set this to false to skip verifying SSL certificate when calling API
# from https server.
self.verify_ssl = True self.verify_ssl = True
# Set this to customize the certificate file to verify the peer. """SSL/TLS verification
Set this to false to skip verifying SSL certificate when calling API
from https server.
"""
self.ssl_ca_cert = None self.ssl_ca_cert = None
# client certificate file """Set this to customize the certificate file to verify the peer.
"""
self.cert_file = None self.cert_file = None
# client key file """client certificate file
"""
self.key_file = None self.key_file = None
# Set this to True/False to enable/disable SSL hostname verification. """client key file
"""
self.assert_hostname = None self.assert_hostname = None
"""Set this to True/False to enable/disable SSL hostname verification.
"""
# urllib3 connection pool's maximum number of connections saved
# per pool. urllib3 uses 1 connection as default value, but this is
# not the best value when you are making a lot of possibly parallel
# requests to the same host, which is often the case here.
# cpu_count * 5 is used as default value to increase performance.
self.connection_pool_maxsize = multiprocessing.cpu_count() * 5 self.connection_pool_maxsize = multiprocessing.cpu_count() * 5
"""urllib3 connection pool's maximum number of connections saved
per pool. urllib3 uses 1 connection as default value, but this is
not the best value when you are making a lot of possibly parallel
requests to the same host, which is often the case here.
cpu_count * 5 is used as default value to increase performance.
"""
# Proxy URL
self.proxy = None self.proxy = None
# Proxy headers """Proxy URL
"""
self.proxy_headers = None self.proxy_headers = None
# Safe chars for path_param """Proxy headers
"""
self.safe_chars_for_path_param = '' self.safe_chars_for_path_param = ''
# Adding retries to override urllib3 default value 3 """Safe chars for path_param
"""
self.retries = None self.retries = None
"""Adding retries to override urllib3 default value 3
"""
@property @property
def logger_file(self): def logger_file(self):

5
samples/openapi3/client/petstore/python/docs/AnotherFakeApi.md
View File

@@ -54,5 +54,10 @@ No authorization required
- **Content-Type**: application/json - **Content-Type**: application/json
- **Accept**: application/json - **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
[[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)

5
samples/openapi3/client/petstore/python/docs/DefaultApi.md
View File

@@ -47,5 +47,10 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/json - **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**0** | 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)

67
samples/openapi3/client/petstore/python/docs/FakeApi.md
View File

@@ -60,6 +60,11 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/json - **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The instance started successfully | - |
[[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)
# **fake_outer_boolean_serialize** # **fake_outer_boolean_serialize**
@@ -108,6 +113,11 @@ No authorization required
- **Content-Type**: application/json - **Content-Type**: application/json
- **Accept**: */* - **Accept**: */*
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Output boolean | - |
[[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)
# **fake_outer_composite_serialize** # **fake_outer_composite_serialize**
@@ -156,6 +166,11 @@ No authorization required
- **Content-Type**: application/json - **Content-Type**: application/json
- **Accept**: */* - **Accept**: */*
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Output composite | - |
[[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)
# **fake_outer_number_serialize** # **fake_outer_number_serialize**
@@ -204,6 +219,11 @@ No authorization required
- **Content-Type**: application/json - **Content-Type**: application/json
- **Accept**: */* - **Accept**: */*
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Output number | - |
[[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)
# **fake_outer_string_serialize** # **fake_outer_string_serialize**
@@ -252,6 +272,11 @@ No authorization required
- **Content-Type**: application/json - **Content-Type**: application/json
- **Accept**: */* - **Accept**: */*
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Output string | - |
[[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)
# **test_body_with_file_schema** # **test_body_with_file_schema**
@@ -299,6 +324,11 @@ No authorization required
- **Content-Type**: application/json - **Content-Type**: application/json
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Success | - |
[[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)
# **test_body_with_query_params** # **test_body_with_query_params**
@@ -346,6 +376,11 @@ No authorization required
- **Content-Type**: application/json - **Content-Type**: application/json
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Success | - |
[[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)
# **test_client_model** # **test_client_model**
@@ -395,6 +430,11 @@ No authorization required
- **Content-Type**: application/json - **Content-Type**: application/json
- **Accept**: application/json - **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
[[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)
# **test_endpoint_parameters** # **test_endpoint_parameters**
@@ -474,6 +514,12 @@ void (empty response body)
- **Content-Type**: application/x-www-form-urlencoded - **Content-Type**: application/x-www-form-urlencoded
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**400** | Invalid username supplied | - |
**404** | User not found | - |
[[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)
# **test_enum_parameters** # **test_enum_parameters**
@@ -536,6 +582,12 @@ No authorization required
- **Content-Type**: application/x-www-form-urlencoded - **Content-Type**: application/x-www-form-urlencoded
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**400** | Invalid request | - |
**404** | Not found | - |
[[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)
# **test_group_parameters** # **test_group_parameters**
@@ -598,6 +650,11 @@ void (empty response body)
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**400** | Someting wrong | - |
[[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)
# **test_inline_additional_properties** # **test_inline_additional_properties**
@@ -644,6 +701,11 @@ No authorization required
- **Content-Type**: application/json - **Content-Type**: application/json
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
[[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)
# **test_json_form_data** # **test_json_form_data**
@@ -692,5 +754,10 @@ No authorization required
- **Content-Type**: application/x-www-form-urlencoded - **Content-Type**: application/x-www-form-urlencoded
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
[[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)

5
samples/openapi3/client/petstore/python/docs/FakeClassnameTags123Api.md
View File

@@ -60,5 +60,10 @@ Name | Type | Description | Notes
- **Content-Type**: application/json - **Content-Type**: application/json
- **Accept**: application/json - **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
[[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)

51
samples/openapi3/client/petstore/python/docs/PetApi.md
View File

@@ -63,6 +63,11 @@ void (empty response body)
- **Content-Type**: application/json, application/xml - **Content-Type**: application/json, application/xml
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**405** | Invalid input | - |
[[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_pet** # **delete_pet**
@@ -115,6 +120,11 @@ void (empty response body)
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**400** | Invalid pet value | - |
[[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)
# **find_pets_by_status** # **find_pets_by_status**
@@ -168,6 +178,12 @@ Name | Type | Description | Notes
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/xml, application/json - **Accept**: application/xml, application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
**400** | Invalid status value | - |
[[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)
# **find_pets_by_tags** # **find_pets_by_tags**
@@ -221,6 +237,12 @@ Name | Type | Description | Notes
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/xml, application/json - **Accept**: application/xml, application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
**400** | Invalid tag value | - |
[[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_pet_by_id** # **get_pet_by_id**
@@ -276,6 +298,13 @@ Name | Type | Description | Notes
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/xml, application/json - **Accept**: application/xml, application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
**400** | Invalid ID supplied | - |
**404** | Pet not found | - |
[[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)
# **update_pet** # **update_pet**
@@ -326,6 +355,13 @@ void (empty response body)
- **Content-Type**: application/json, application/xml - **Content-Type**: application/json, application/xml
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**400** | Invalid ID supplied | - |
**404** | Pet not found | - |
**405** | Validation exception | - |
[[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)
# **update_pet_with_form** # **update_pet_with_form**
@@ -380,6 +416,11 @@ void (empty response body)
- **Content-Type**: application/x-www-form-urlencoded - **Content-Type**: application/x-www-form-urlencoded
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**405** | Invalid input | - |
[[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)
# **upload_file** # **upload_file**
@@ -435,6 +476,11 @@ Name | Type | Description | Notes
- **Content-Type**: multipart/form-data - **Content-Type**: multipart/form-data
- **Accept**: application/json - **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
[[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)
# **upload_file_with_required_file** # **upload_file_with_required_file**
@@ -490,5 +536,10 @@ Name | Type | Description | Notes
- **Content-Type**: multipart/form-data - **Content-Type**: multipart/form-data
- **Accept**: application/json - **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
[[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)

24
samples/openapi3/client/petstore/python/docs/StoreApi.md
View File

@@ -56,6 +56,12 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**400** | Invalid ID supplied | - |
**404** | Order not found | - |
[[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_inventory** # **get_inventory**
@@ -107,6 +113,11 @@ This endpoint does not need any parameter.
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/json - **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
[[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_order_by_id** # **get_order_by_id**
@@ -156,6 +167,13 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/xml, application/json - **Accept**: application/xml, application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
**400** | Invalid ID supplied | - |
**404** | Order not found | - |
[[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)
# **place_order** # **place_order**
@@ -203,5 +221,11 @@ No authorization required
- **Content-Type**: application/json - **Content-Type**: application/json
- **Accept**: application/xml, application/json - **Accept**: application/xml, application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
**400** | Invalid Order | - |
[[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)

45
samples/openapi3/client/petstore/python/docs/UserApi.md
View File

@@ -60,6 +60,11 @@ No authorization required
- **Content-Type**: application/json - **Content-Type**: application/json
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**0** | successful operation | - |
[[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_users_with_array_input** # **create_users_with_array_input**
@@ -106,6 +111,11 @@ No authorization required
- **Content-Type**: application/json - **Content-Type**: application/json
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**0** | successful operation | - |
[[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_users_with_list_input** # **create_users_with_list_input**
@@ -152,6 +162,11 @@ No authorization required
- **Content-Type**: application/json - **Content-Type**: application/json
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**0** | successful operation | - |
[[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_user** # **delete_user**
@@ -200,6 +215,12 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**400** | Invalid username supplied | - |
**404** | User not found | - |
[[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_user_by_name** # **get_user_by_name**
@@ -247,6 +268,13 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/xml, application/json - **Accept**: application/xml, application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | - |
**400** | Invalid username supplied | - |
**404** | User not found | - |
[[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)
# **login_user** # **login_user**
@@ -296,6 +324,12 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: application/xml, application/json - **Accept**: application/xml, application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful operation | * X-Rate-Limit - calls per hour allowed by the user <br> * X-Expires-After - date in UTC when token expires <br> |
**400** | Invalid username/password supplied | - |
[[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)
# **logout_user** # **logout_user**
@@ -338,6 +372,11 @@ No authorization required
- **Content-Type**: Not defined - **Content-Type**: Not defined
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**0** | successful operation | - |
[[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)
# **update_user** # **update_user**
@@ -388,5 +427,11 @@ No authorization required
- **Content-Type**: application/json - **Content-Type**: application/json
- **Accept**: Not defined - **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**400** | Invalid user supplied | - |
**404** | User not found | - |
[[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)

22
samples/openapi3/client/petstore/python/petstore_api/api/another_fake_api.py
View File

@@ -45,8 +45,15 @@ class AnotherFakeApi(object):
>>> thread = api.call_123_test_special_tags(client, async_req=True) >>> thread = api.call_123_test_special_tags(client, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Client client: client model (required) :param Client client: client model (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: Client :return: Client
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -63,9 +70,18 @@ class AnotherFakeApi(object):
>>> thread = api.call_123_test_special_tags_with_http_info(client, async_req=True) >>> thread = api.call_123_test_special_tags_with_http_info(client, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Client client: client model (required) :param Client client: client model (required)
:return: Client :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(Client, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """

22
samples/openapi3/client/petstore/python/petstore_api/api/default_api.py
View File

@@ -44,7 +44,14 @@ class DefaultApi(object):
>>> thread = api.foo_get(async_req=True) >>> thread = api.foo_get(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: InlineResponseDefault :return: InlineResponseDefault
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -60,8 +67,17 @@ class DefaultApi(object):
>>> thread = api.foo_get_with_http_info(async_req=True) >>> thread = api.foo_get_with_http_info(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:return: InlineResponseDefault :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(InlineResponseDefault, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """

272
samples/openapi3/client/petstore/python/petstore_api/api/fake_api.py
View File

@@ -44,7 +44,14 @@ class FakeApi(object):
>>> thread = api.fake_health_get(async_req=True) >>> thread = api.fake_health_get(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: HealthCheckResult :return: HealthCheckResult
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -60,8 +67,17 @@ class FakeApi(object):
>>> thread = api.fake_health_get_with_http_info(async_req=True) >>> thread = api.fake_health_get_with_http_info(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:return: HealthCheckResult :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(HealthCheckResult, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -127,8 +143,15 @@ class FakeApi(object):
>>> thread = api.fake_outer_boolean_serialize(async_req=True) >>> thread = api.fake_outer_boolean_serialize(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param bool body: Input boolean as post body :param bool body: Input boolean as post body
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: bool :return: bool
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -145,9 +168,18 @@ class FakeApi(object):
>>> thread = api.fake_outer_boolean_serialize_with_http_info(async_req=True) >>> thread = api.fake_outer_boolean_serialize_with_http_info(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param bool body: Input boolean as post body :param bool body: Input boolean as post body
:return: bool :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(bool, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -219,8 +251,15 @@ class FakeApi(object):
>>> thread = api.fake_outer_composite_serialize(async_req=True) >>> thread = api.fake_outer_composite_serialize(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param OuterComposite outer_composite: Input composite as post body :param OuterComposite outer_composite: Input composite as post body
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: OuterComposite :return: OuterComposite
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -237,9 +276,18 @@ class FakeApi(object):
>>> thread = api.fake_outer_composite_serialize_with_http_info(async_req=True) >>> thread = api.fake_outer_composite_serialize_with_http_info(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param OuterComposite outer_composite: Input composite as post body :param OuterComposite outer_composite: Input composite as post body
:return: OuterComposite :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(OuterComposite, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -311,8 +359,15 @@ class FakeApi(object):
>>> thread = api.fake_outer_number_serialize(async_req=True) >>> thread = api.fake_outer_number_serialize(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param float body: Input number as post body :param float body: Input number as post body
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: float :return: float
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -329,9 +384,18 @@ class FakeApi(object):
>>> thread = api.fake_outer_number_serialize_with_http_info(async_req=True) >>> thread = api.fake_outer_number_serialize_with_http_info(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param float body: Input number as post body :param float body: Input number as post body
:return: float :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(float, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -403,8 +467,15 @@ class FakeApi(object):
>>> thread = api.fake_outer_string_serialize(async_req=True) >>> thread = api.fake_outer_string_serialize(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str body: Input string as post body :param str body: Input string as post body
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: str :return: str
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -421,9 +492,18 @@ class FakeApi(object):
>>> thread = api.fake_outer_string_serialize_with_http_info(async_req=True) >>> thread = api.fake_outer_string_serialize_with_http_info(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str body: Input string as post body :param str body: Input string as post body
:return: str :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(str, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -495,8 +575,15 @@ class FakeApi(object):
>>> thread = api.test_body_with_file_schema(file_schema_test_class, async_req=True) >>> thread = api.test_body_with_file_schema(file_schema_test_class, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param FileSchemaTestClass file_schema_test_class: (required) :param FileSchemaTestClass file_schema_test_class: (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -513,8 +600,17 @@ class FakeApi(object):
>>> thread = api.test_body_with_file_schema_with_http_info(file_schema_test_class, async_req=True) >>> thread = api.test_body_with_file_schema_with_http_info(file_schema_test_class, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param FileSchemaTestClass file_schema_test_class: (required) :param FileSchemaTestClass file_schema_test_class: (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -586,9 +682,16 @@ class FakeApi(object):
>>> thread = api.test_body_with_query_params(query, user, async_req=True) >>> thread = api.test_body_with_query_params(query, user, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str query: (required) :param str query: (required)
:param User user: (required) :param User user: (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -604,9 +707,18 @@ class FakeApi(object):
>>> thread = api.test_body_with_query_params_with_http_info(query, user, async_req=True) >>> thread = api.test_body_with_query_params_with_http_info(query, user, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str query: (required) :param str query: (required)
:param User user: (required) :param User user: (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -685,8 +797,15 @@ class FakeApi(object):
>>> thread = api.test_client_model(client, async_req=True) >>> thread = api.test_client_model(client, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Client client: client model (required) :param Client client: client model (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: Client :return: Client
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -703,9 +822,18 @@ class FakeApi(object):
>>> thread = api.test_client_model_with_http_info(client, async_req=True) >>> thread = api.test_client_model_with_http_info(client, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Client client: client model (required) :param Client client: client model (required)
:return: Client :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(Client, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -781,7 +909,7 @@ class FakeApi(object):
>>> thread = api.test_endpoint_parameters(number, double, pattern_without_delimiter, byte, async_req=True) >>> thread = api.test_endpoint_parameters(number, double, pattern_without_delimiter, byte, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param float number: None (required) :param float number: None (required)
:param float double: None (required) :param float double: None (required)
:param str pattern_without_delimiter: None (required) :param str pattern_without_delimiter: None (required)
@@ -796,6 +924,13 @@ class FakeApi(object):
:param datetime date_time: None :param datetime date_time: None
:param str password: None :param str password: None
:param str param_callback: None :param str param_callback: None
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -812,7 +947,7 @@ class FakeApi(object):
>>> thread = api.test_endpoint_parameters_with_http_info(number, double, pattern_without_delimiter, byte, async_req=True) >>> thread = api.test_endpoint_parameters_with_http_info(number, double, pattern_without_delimiter, byte, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param float number: None (required) :param float number: None (required)
:param float double: None (required) :param float double: None (required)
:param str pattern_without_delimiter: None (required) :param str pattern_without_delimiter: None (required)
@@ -827,6 +962,15 @@ class FakeApi(object):
:param datetime date_time: None :param datetime date_time: None
:param str password: None :param str password: None
:param str param_callback: None :param str param_callback: None
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -965,7 +1109,7 @@ class FakeApi(object):
>>> thread = api.test_enum_parameters(async_req=True) >>> thread = api.test_enum_parameters(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param list[str] enum_header_string_array: Header parameter enum test (string array) :param list[str] enum_header_string_array: Header parameter enum test (string array)
:param str enum_header_string: Header parameter enum test (string) :param str enum_header_string: Header parameter enum test (string)
:param list[str] enum_query_string_array: Query parameter enum test (string array) :param list[str] enum_query_string_array: Query parameter enum test (string array)
@@ -974,6 +1118,13 @@ class FakeApi(object):
:param float enum_query_double: Query parameter enum test (double) :param float enum_query_double: Query parameter enum test (double)
:param list[str] enum_form_string_array: Form parameter enum test (string array) :param list[str] enum_form_string_array: Form parameter enum test (string array)
:param str enum_form_string: Form parameter enum test (string) :param str enum_form_string: Form parameter enum test (string)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -990,7 +1141,7 @@ class FakeApi(object):
>>> thread = api.test_enum_parameters_with_http_info(async_req=True) >>> thread = api.test_enum_parameters_with_http_info(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param list[str] enum_header_string_array: Header parameter enum test (string array) :param list[str] enum_header_string_array: Header parameter enum test (string array)
:param str enum_header_string: Header parameter enum test (string) :param str enum_header_string: Header parameter enum test (string)
:param list[str] enum_query_string_array: Query parameter enum test (string array) :param list[str] enum_query_string_array: Query parameter enum test (string array)
@@ -999,6 +1150,15 @@ class FakeApi(object):
:param float enum_query_double: Query parameter enum test (double) :param float enum_query_double: Query parameter enum test (double)
:param list[str] enum_form_string_array: Form parameter enum test (string array) :param list[str] enum_form_string_array: Form parameter enum test (string array)
:param str enum_form_string: Form parameter enum test (string) :param str enum_form_string: Form parameter enum test (string)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -1084,13 +1244,20 @@ class FakeApi(object):
>>> thread = api.test_group_parameters(required_string_group, required_boolean_group, required_int64_group, async_req=True) >>> thread = api.test_group_parameters(required_string_group, required_boolean_group, required_int64_group, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int required_string_group: Required String in group parameters (required) :param int required_string_group: Required String in group parameters (required)
:param bool required_boolean_group: Required Boolean in group parameters (required) :param bool required_boolean_group: Required Boolean in group parameters (required)
:param int required_int64_group: Required Integer in group parameters (required) :param int required_int64_group: Required Integer in group parameters (required)
:param int string_group: String in group parameters :param int string_group: String in group parameters
:param bool boolean_group: Boolean in group parameters :param bool boolean_group: Boolean in group parameters
:param int int64_group: Integer in group parameters :param int int64_group: Integer in group parameters
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -1107,13 +1274,22 @@ class FakeApi(object):
>>> thread = api.test_group_parameters_with_http_info(required_string_group, required_boolean_group, required_int64_group, async_req=True) >>> thread = api.test_group_parameters_with_http_info(required_string_group, required_boolean_group, required_int64_group, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int required_string_group: Required String in group parameters (required) :param int required_string_group: Required String in group parameters (required)
:param bool required_boolean_group: Required Boolean in group parameters (required) :param bool required_boolean_group: Required Boolean in group parameters (required)
:param int required_int64_group: Required Integer in group parameters (required) :param int required_int64_group: Required Integer in group parameters (required)
:param int string_group: String in group parameters :param int string_group: String in group parameters
:param bool boolean_group: Boolean in group parameters :param bool boolean_group: Boolean in group parameters
:param int int64_group: Integer in group parameters :param int int64_group: Integer in group parameters
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -1199,8 +1375,15 @@ class FakeApi(object):
>>> thread = api.test_inline_additional_properties(request_body, async_req=True) >>> thread = api.test_inline_additional_properties(request_body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param dict(str, str) request_body: request body (required) :param dict(str, str) request_body: request body (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -1216,8 +1399,17 @@ class FakeApi(object):
>>> thread = api.test_inline_additional_properties_with_http_info(request_body, async_req=True) >>> thread = api.test_inline_additional_properties_with_http_info(request_body, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param dict(str, str) request_body: request body (required) :param dict(str, str) request_body: request body (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -1289,9 +1481,16 @@ class FakeApi(object):
>>> thread = api.test_json_form_data(param, param2, async_req=True) >>> thread = api.test_json_form_data(param, param2, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str param: field1 (required) :param str param: field1 (required)
:param str param2: field2 (required) :param str param2: field2 (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -1307,9 +1506,18 @@ class FakeApi(object):
>>> thread = api.test_json_form_data_with_http_info(param, param2, async_req=True) >>> thread = api.test_json_form_data_with_http_info(param, param2, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str param: field1 (required) :param str param: field1 (required)
:param str param2: field2 (required) :param str param2: field2 (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.

22
samples/openapi3/client/petstore/python/petstore_api/api/fake_classname_tags_123_api.py
View File

@@ -45,8 +45,15 @@ class FakeClassnameTags123Api(object):
>>> thread = api.test_classname(client, async_req=True) >>> thread = api.test_classname(client, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Client client: client model (required) :param Client client: client model (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: Client :return: Client
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -63,9 +70,18 @@ class FakeClassnameTags123Api(object):
>>> thread = api.test_classname_with_http_info(client, async_req=True) >>> thread = api.test_classname_with_http_info(client, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Client client: client model (required) :param Client client: client model (required)
:return: Client :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(Client, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """

190
samples/openapi3/client/petstore/python/petstore_api/api/pet_api.py
View File

@@ -44,8 +44,15 @@ class PetApi(object):
>>> thread = api.add_pet(pet, async_req=True) >>> thread = api.add_pet(pet, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Pet pet: Pet object that needs to be added to the store (required) :param Pet pet: Pet object that needs to be added to the store (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -61,8 +68,17 @@ class PetApi(object):
>>> thread = api.add_pet_with_http_info(pet, async_req=True) >>> thread = api.add_pet_with_http_info(pet, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Pet pet: Pet object that needs to be added to the store (required) :param Pet pet: Pet object that needs to be added to the store (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -141,9 +157,16 @@ class PetApi(object):
>>> thread = api.delete_pet(pet_id, async_req=True) >>> thread = api.delete_pet(pet_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int pet_id: Pet id to delete (required) :param int pet_id: Pet id to delete (required)
:param str api_key: :param str api_key:
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -159,9 +182,18 @@ class PetApi(object):
>>> thread = api.delete_pet_with_http_info(pet_id, async_req=True) >>> thread = api.delete_pet_with_http_info(pet_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int pet_id: Pet id to delete (required) :param int pet_id: Pet id to delete (required)
:param str api_key: :param str api_key:
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -232,8 +264,15 @@ class PetApi(object):
>>> thread = api.find_pets_by_status(status, async_req=True) >>> thread = api.find_pets_by_status(status, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param list[str] status: Status values that need to be considered for filter (required) :param list[str] status: Status values that need to be considered for filter (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: list[Pet] :return: list[Pet]
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -250,9 +289,18 @@ class PetApi(object):
>>> thread = api.find_pets_by_status_with_http_info(status, async_req=True) >>> thread = api.find_pets_by_status_with_http_info(status, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param list[str] status: Status values that need to be considered for filter (required) :param list[str] status: Status values that need to be considered for filter (required)
:return: list[Pet] :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(list[Pet], status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -325,8 +373,15 @@ class PetApi(object):
>>> thread = api.find_pets_by_tags(tags, async_req=True) >>> thread = api.find_pets_by_tags(tags, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param list[str] tags: Tags to filter by (required) :param list[str] tags: Tags to filter by (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: list[Pet] :return: list[Pet]
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -343,9 +398,18 @@ class PetApi(object):
>>> thread = api.find_pets_by_tags_with_http_info(tags, async_req=True) >>> thread = api.find_pets_by_tags_with_http_info(tags, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param list[str] tags: Tags to filter by (required) :param list[str] tags: Tags to filter by (required)
:return: list[Pet] :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(list[Pet], status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -418,8 +482,15 @@ class PetApi(object):
>>> thread = api.get_pet_by_id(pet_id, async_req=True) >>> thread = api.get_pet_by_id(pet_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int pet_id: ID of pet to return (required) :param int pet_id: ID of pet to return (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: Pet :return: Pet
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -436,9 +507,18 @@ class PetApi(object):
>>> thread = api.get_pet_by_id_with_http_info(pet_id, async_req=True) >>> thread = api.get_pet_by_id_with_http_info(pet_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int pet_id: ID of pet to return (required) :param int pet_id: ID of pet to return (required)
:return: Pet :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(Pet, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -509,8 +589,15 @@ class PetApi(object):
>>> thread = api.update_pet(pet, async_req=True) >>> thread = api.update_pet(pet, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Pet pet: Pet object that needs to be added to the store (required) :param Pet pet: Pet object that needs to be added to the store (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -526,8 +613,17 @@ class PetApi(object):
>>> thread = api.update_pet_with_http_info(pet, async_req=True) >>> thread = api.update_pet_with_http_info(pet, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Pet pet: Pet object that needs to be added to the store (required) :param Pet pet: Pet object that needs to be added to the store (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -606,10 +702,17 @@ class PetApi(object):
>>> thread = api.update_pet_with_form(pet_id, async_req=True) >>> thread = api.update_pet_with_form(pet_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int pet_id: ID of pet that needs to be updated (required) :param int pet_id: ID of pet that needs to be updated (required)
:param str name: Updated name of the pet :param str name: Updated name of the pet
:param str status: Updated status of the pet :param str status: Updated status of the pet
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -625,10 +728,19 @@ class PetApi(object):
>>> thread = api.update_pet_with_form_with_http_info(pet_id, async_req=True) >>> thread = api.update_pet_with_form_with_http_info(pet_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int pet_id: ID of pet that needs to be updated (required) :param int pet_id: ID of pet that needs to be updated (required)
:param str name: Updated name of the pet :param str name: Updated name of the pet
:param str status: Updated status of the pet :param str status: Updated status of the pet
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -704,10 +816,17 @@ class PetApi(object):
>>> thread = api.upload_file(pet_id, async_req=True) >>> thread = api.upload_file(pet_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int pet_id: ID of pet to update (required) :param int pet_id: ID of pet to update (required)
:param str additional_metadata: Additional data to pass to server :param str additional_metadata: Additional data to pass to server
:param file file: file to upload :param file file: file to upload
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: ApiResponse :return: ApiResponse
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -723,11 +842,20 @@ class PetApi(object):
>>> thread = api.upload_file_with_http_info(pet_id, async_req=True) >>> thread = api.upload_file_with_http_info(pet_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int pet_id: ID of pet to update (required) :param int pet_id: ID of pet to update (required)
:param str additional_metadata: Additional data to pass to server :param str additional_metadata: Additional data to pass to server
:param file file: file to upload :param file file: file to upload
:return: ApiResponse :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(ApiResponse, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -806,10 +934,17 @@ class PetApi(object):
>>> thread = api.upload_file_with_required_file(pet_id, required_file, async_req=True) >>> thread = api.upload_file_with_required_file(pet_id, required_file, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int pet_id: ID of pet to update (required) :param int pet_id: ID of pet to update (required)
:param file required_file: file to upload (required) :param file required_file: file to upload (required)
:param str additional_metadata: Additional data to pass to server :param str additional_metadata: Additional data to pass to server
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: ApiResponse :return: ApiResponse
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -825,11 +960,20 @@ class PetApi(object):
>>> thread = api.upload_file_with_required_file_with_http_info(pet_id, required_file, async_req=True) >>> thread = api.upload_file_with_required_file_with_http_info(pet_id, required_file, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int pet_id: ID of pet to update (required) :param int pet_id: ID of pet to update (required)
:param file required_file: file to upload (required) :param file required_file: file to upload (required)
:param str additional_metadata: Additional data to pass to server :param str additional_metadata: Additional data to pass to server
:return: ApiResponse :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(ApiResponse, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """

86
samples/openapi3/client/petstore/python/petstore_api/api/store_api.py
View File

@@ -45,8 +45,15 @@ class StoreApi(object):
>>> thread = api.delete_order(order_id, async_req=True) >>> thread = api.delete_order(order_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str order_id: ID of the order that needs to be deleted (required) :param str order_id: ID of the order that needs to be deleted (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -63,8 +70,17 @@ class StoreApi(object):
>>> thread = api.delete_order_with_http_info(order_id, async_req=True) >>> thread = api.delete_order_with_http_info(order_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str order_id: ID of the order that needs to be deleted (required) :param str order_id: ID of the order that needs to be deleted (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -133,7 +149,14 @@ class StoreApi(object):
>>> thread = api.get_inventory(async_req=True) >>> thread = api.get_inventory(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: dict(str, int) :return: dict(str, int)
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -150,8 +173,17 @@ class StoreApi(object):
>>> thread = api.get_inventory_with_http_info(async_req=True) >>> thread = api.get_inventory_with_http_info(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:return: dict(str, int) :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(dict(str, int), status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -217,8 +249,15 @@ class StoreApi(object):
>>> thread = api.get_order_by_id(order_id, async_req=True) >>> thread = api.get_order_by_id(order_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int order_id: ID of pet that needs to be fetched (required) :param int order_id: ID of pet that needs to be fetched (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: Order :return: Order
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -235,9 +274,18 @@ class StoreApi(object):
>>> thread = api.get_order_by_id_with_http_info(order_id, async_req=True) >>> thread = api.get_order_by_id_with_http_info(order_id, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param int order_id: ID of pet that needs to be fetched (required) :param int order_id: ID of pet that needs to be fetched (required)
:return: Order :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(Order, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -312,8 +360,15 @@ class StoreApi(object):
>>> thread = api.place_order(order, async_req=True) >>> thread = api.place_order(order, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Order order: order placed for purchasing the pet (required) :param Order order: order placed for purchasing the pet (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: Order :return: Order
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -329,9 +384,18 @@ class StoreApi(object):
>>> thread = api.place_order_with_http_info(order, async_req=True) >>> thread = api.place_order_with_http_info(order, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param Order order: order placed for purchasing the pet (required) :param Order order: order placed for purchasing the pet (required)
:return: Order :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(Order, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """

164
samples/openapi3/client/petstore/python/petstore_api/api/user_api.py
View File

@@ -45,8 +45,15 @@ class UserApi(object):
>>> thread = api.create_user(user, async_req=True) >>> thread = api.create_user(user, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param User user: Created user object (required) :param User user: Created user object (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -63,8 +70,17 @@ class UserApi(object):
>>> thread = api.create_user_with_http_info(user, async_req=True) >>> thread = api.create_user_with_http_info(user, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param User user: Created user object (required) :param User user: Created user object (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -136,8 +152,15 @@ class UserApi(object):
>>> thread = api.create_users_with_array_input(user, async_req=True) >>> thread = api.create_users_with_array_input(user, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param list[User] user: List of user object (required) :param list[User] user: List of user object (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -153,8 +176,17 @@ class UserApi(object):
>>> thread = api.create_users_with_array_input_with_http_info(user, async_req=True) >>> thread = api.create_users_with_array_input_with_http_info(user, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param list[User] user: List of user object (required) :param list[User] user: List of user object (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -226,8 +258,15 @@ class UserApi(object):
>>> thread = api.create_users_with_list_input(user, async_req=True) >>> thread = api.create_users_with_list_input(user, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param list[User] user: List of user object (required) :param list[User] user: List of user object (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -243,8 +282,17 @@ class UserApi(object):
>>> thread = api.create_users_with_list_input_with_http_info(user, async_req=True) >>> thread = api.create_users_with_list_input_with_http_info(user, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param list[User] user: List of user object (required) :param list[User] user: List of user object (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -317,8 +365,15 @@ class UserApi(object):
>>> thread = api.delete_user(username, async_req=True) >>> thread = api.delete_user(username, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str username: The name that needs to be deleted (required) :param str username: The name that needs to be deleted (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -335,8 +390,17 @@ class UserApi(object):
>>> thread = api.delete_user_with_http_info(username, async_req=True) >>> thread = api.delete_user_with_http_info(username, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str username: The name that needs to be deleted (required) :param str username: The name that needs to be deleted (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -404,8 +468,15 @@ class UserApi(object):
>>> thread = api.get_user_by_name(username, async_req=True) >>> thread = api.get_user_by_name(username, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str username: The name that needs to be fetched. Use user1 for testing. (required) :param str username: The name that needs to be fetched. Use user1 for testing. (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: User :return: User
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -421,9 +492,18 @@ class UserApi(object):
>>> thread = api.get_user_by_name_with_http_info(username, async_req=True) >>> thread = api.get_user_by_name_with_http_info(username, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str username: The name that needs to be fetched. Use user1 for testing. (required) :param str username: The name that needs to be fetched. Use user1 for testing. (required)
:return: User :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(User, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -494,9 +574,16 @@ class UserApi(object):
>>> thread = api.login_user(username, password, async_req=True) >>> thread = api.login_user(username, password, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str username: The user name for login (required) :param str username: The user name for login (required)
:param str password: The password for login in clear text (required) :param str password: The password for login in clear text (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: str :return: str
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -512,10 +599,19 @@ class UserApi(object):
>>> thread = api.login_user_with_http_info(username, password, async_req=True) >>> thread = api.login_user_with_http_info(username, password, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str username: The user name for login (required) :param str username: The user name for login (required)
:param str password: The password for login in clear text (required) :param str password: The password for login in clear text (required)
:return: str :param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: tuple(str, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
""" """
@@ -592,7 +688,14 @@ class UserApi(object):
>>> thread = api.logout_user(async_req=True) >>> thread = api.logout_user(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -608,7 +711,16 @@ class UserApi(object):
>>> thread = api.logout_user_with_http_info(async_req=True) >>> thread = api.logout_user_with_http_info(async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -671,9 +783,16 @@ class UserApi(object):
>>> thread = api.update_user(username, user, async_req=True) >>> thread = api.update_user(username, user, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str username: name that need to be deleted (required) :param str username: name that need to be deleted (required)
:param User user: Updated user object (required) :param User user: Updated user object (required)
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.
@@ -690,9 +809,18 @@ class UserApi(object):
>>> thread = api.update_user_with_http_info(username, user, async_req=True) >>> thread = api.update_user_with_http_info(username, user, async_req=True)
>>> result = thread.get() >>> result = thread.get()
:param async_req bool :param async_req bool: execute request asynchronously
:param str username: name that need to be deleted (required) :param str username: name that need to be deleted (required)
:param User user: Updated user object (required) :param User user: Updated user object (required)
:param _return_http_data_only: response data without head status code
and headers
:param _preload_content: if False, the urllib3.HTTPResponse object will
be returned without reading/decoding response
data. Default is True.
:param _request_timeout: timeout setting for this request. If one
number provided, it will be total request
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: None :return: None
If the method is called asynchronously, If the method is called asynchronously,
returns the request thread. returns the request thread.

109
samples/openapi3/client/petstore/python/petstore_api/configuration.py
View File

@@ -27,9 +27,9 @@ class TypeWithDefault(type):
super(TypeWithDefault, cls).__init__(name, bases, dct) super(TypeWithDefault, cls).__init__(name, bases, dct)
cls._default = None cls._default = None
def __call__(cls): def __call__(cls, **kwargs):
if cls._default is None: if cls._default is None:
cls._default = type.__call__(cls) cls._default = type.__call__(cls, **kwargs)
return copy.copy(cls._default) return copy.copy(cls._default)
def set_default(cls, default): def set_default(cls, default):
@@ -41,69 +41,100 @@ class Configuration(six.with_metaclass(TypeWithDefault, object)):
Ref: https://openapi-generator.tech Ref: https://openapi-generator.tech
Do not edit the class manually. Do not edit the class manually.
:param host: Base url
:param api_key: Dict to store API key(s)
:param api_key_prefix: Dict to store API prefix (e.g. Bearer)
:param username: Username for HTTP basic authentication
:param password: Password for HTTP basic authentication
""" """
def __init__(self): def __init__(self, host="http://petstore.swagger.io:80/v2",
"""Constructor""" api_key={}, api_key_prefix={},
# Default Base url username="", password=""):
self.host = "http://petstore.swagger.io:80/v2" """Constructor
# Temp file folder for downloading files """
self.host = host
"""Default Base url
"""
self.temp_folder_path = None self.temp_folder_path = None
"""Temp file folder for downloading files
"""
# Authentication Settings # Authentication Settings
# dict to store API key(s) self.api_key = api_key
self.api_key = {} """dict to store API key(s)
# dict to store API prefix (e.g. Bearer) """
self.api_key_prefix = {} self.api_key_prefix = api_key_prefix
# Username for HTTP basic authentication """dict to store API prefix (e.g. Bearer)
self.username = "" """
# Password for HTTP basic authentication self.username = username
self.password = "" """Username for HTTP basic authentication
# access token for OAuth/Bearer """
self.password = password
"""Password for HTTP basic authentication
"""
self.access_token = "" self.access_token = ""
# Logging Settings """access token for OAuth/Bearer
"""
self.logger = {} self.logger = {}
"""Logging Settings
"""
self.logger["package_logger"] = logging.getLogger("petstore_api") self.logger["package_logger"] = logging.getLogger("petstore_api")
self.logger["urllib3_logger"] = logging.getLogger("urllib3") self.logger["urllib3_logger"] = logging.getLogger("urllib3")
# Log format
self.logger_format = '%(asctime)s %(levelname)s %(message)s' self.logger_format = '%(asctime)s %(levelname)s %(message)s'
# Log stream handler """Log format
"""
self.logger_stream_handler = None self.logger_stream_handler = None
# Log file handler """Log stream handler
"""
self.logger_file_handler = None self.logger_file_handler = None
# Debug file location """Log file handler
"""
self.logger_file = None self.logger_file = None
# Debug switch """Debug file location
"""
self.debug = False self.debug = False
"""Debug switch
"""
# SSL/TLS verification
# Set this to false to skip verifying SSL certificate when calling API
# from https server.
self.verify_ssl = True self.verify_ssl = True
# Set this to customize the certificate file to verify the peer. """SSL/TLS verification
Set this to false to skip verifying SSL certificate when calling API
from https server.
"""
self.ssl_ca_cert = None self.ssl_ca_cert = None
# client certificate file """Set this to customize the certificate file to verify the peer.
"""
self.cert_file = None self.cert_file = None
# client key file """client certificate file
"""
self.key_file = None self.key_file = None
# Set this to True/False to enable/disable SSL hostname verification. """client key file
"""
self.assert_hostname = None self.assert_hostname = None
"""Set this to True/False to enable/disable SSL hostname verification.
"""
# urllib3 connection pool's maximum number of connections saved
# per pool. urllib3 uses 1 connection as default value, but this is
# not the best value when you are making a lot of possibly parallel
# requests to the same host, which is often the case here.
# cpu_count * 5 is used as default value to increase performance.
self.connection_pool_maxsize = multiprocessing.cpu_count() * 5 self.connection_pool_maxsize = multiprocessing.cpu_count() * 5
"""urllib3 connection pool's maximum number of connections saved
per pool. urllib3 uses 1 connection as default value, but this is
not the best value when you are making a lot of possibly parallel
requests to the same host, which is often the case here.
cpu_count * 5 is used as default value to increase performance.
"""
# Proxy URL
self.proxy = None self.proxy = None
# Proxy headers """Proxy URL
"""
self.proxy_headers = None self.proxy_headers = None
# Safe chars for path_param """Proxy headers
"""
self.safe_chars_for_path_param = '' self.safe_chars_for_path_param = ''
# Adding retries to override urllib3 default value 3 """Safe chars for path_param
"""
self.retries = None self.retries = None
"""Adding retries to override urllib3 default value 3
"""
@property @property
def logger_file(self): def logger_file(self):