loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity

Add a new Python client generator - python-nextgen (#14157)

Browse Source 
* add python-nextgen generator

* remove client_side_validation from model

* remove configuraiton import from models

* add inheritance support

* update test requirements, tox

* add typings, pydanic to models

* add test model

* minor improvements

* add enum support

* add typing for parameters, remove validations

* add oneof, anyof support

* fix default value

* fix deserialization, api tests passed

* private variable naming, update tests, all tests passed

* remove six

* remove nose

* update doc

* remove sortParamsByRequiredFlag option

* add parameter validation

* add validation tests

* simplify Field()

* remove previous required parameter validation

* improve parameter handling

* support discriminator mapping

* better typing discriminator mapping

* format test code

* fix tests

* fix oneOf from_dict, add test

* add set validation test

* fix nested oneof serialization, add tests

* add model import

* remove models. prefix

* remove import models

* remove model import from api

* simplify from_dict

* add typing for return

* skip pydantic import in return type

* fix tests, fix enum

* restore more enum schema tests

* uncomment enum integer test

* clean up getfullargspec import in model

* clean up getfullargspec import

* fix deserilizatoin for nested oneof

* minor fixes, add tests

* fix regular expression

* add aiohttp samples, add tests

* remove default content type to json

* update template

* fix select accept, content-type

* move tests

* move tests

* fix url query parameters

* fix list

* fix samples

* fix param pydantic, add list as reserved word

* fix auto-generated doc

* fix readme

* fix list, fix special variable name with var_

* fix Literal in python 3.7

* fix default configuration

* fix aiohttp tests

* set default api client instance

* deprecate get_default_copy method

* fix enum model

* fix enum serializatio/deserialization

* add github workflow support

* add regular expression validator

* add enum validator

* better model import

* fix file, remove x-py-import-models

* rename local var

* better model example

* fix regular expression warning, add special_name test, whitelist schema

* skip self import

* update samples

* various fixes

* add base64, json as reserved word

* add http signature support

* add http signature test

* add additioanl properties support in python client

* add decimal support

* use strictstr instead of constr

* fix test with virtualenv

* add nullable support

* add readonly support

* add model name caching

* fix circular reference import

* add onelook discriminator lookup

* add tests

* update samples

* fix locale

* Fix client legacy generator asyncio README code example

* test python-nextgen in circleci

* fix pom.xml

* update python to 3.7.15

* test with python 3.7.12

* various updates

* fix python legacy
This commit is contained in:
William Cheng
2022-12-17 16:05:47 +08:00
committed by GitHub
parent 6800905123
commit 0cf5ed619d
568 changed files with 56832 additions and 272 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/AdditionalPropertiesClass.md Normal file
View File

@@ -0,0 +1,29 @@
# AdditionalPropertiesClass
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**map_property** | **Dict[str, str]** | | [optional]
**map_of_map_property** | **Dict[str, Dict[str, str]]** | | [optional]
## Example
```python
from petstore_api.models.additional_properties_class import AdditionalPropertiesClass
# TODO update the JSON string below
json = "{}"
# create an instance of AdditionalPropertiesClass from a JSON string
additional_properties_class_instance = AdditionalPropertiesClass.from_json(json)
# print the JSON string representation of the object
print AdditionalPropertiesClass.to_json()
# convert the object into a dict
additional_properties_class_dict = additional_properties_class_instance.to_dict()
# create an instance of AdditionalPropertiesClass from a dict
additional_properties_class_form_dict = additional_properties_class.from_dict(additional_properties_class_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

29
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/AllOfWithSingleRef.md Normal file
View File

@@ -0,0 +1,29 @@
# AllOfWithSingleRef
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**username** | **str** | | [optional]
**single_ref_type** | [**SingleRefType**](SingleRefType.md) | | [optional]
## Example
```python
from petstore_api.models.all_of_with_single_ref import AllOfWithSingleRef
# TODO update the JSON string below
json = "{}"
# create an instance of AllOfWithSingleRef from a JSON string
all_of_with_single_ref_instance = AllOfWithSingleRef.from_json(json)
# print the JSON string representation of the object
print AllOfWithSingleRef.to_json()
# convert the object into a dict
all_of_with_single_ref_dict = all_of_with_single_ref_instance.to_dict()
# create an instance of AllOfWithSingleRef from a dict
all_of_with_single_ref_form_dict = all_of_with_single_ref.from_dict(all_of_with_single_ref_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

29
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/Animal.md Normal file
View File

@@ -0,0 +1,29 @@
# Animal
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**class_name** | **str** | |
**color** | **str** | | [optional] [default to 'red']
## Example
```python
from petstore_api.models.animal import Animal
# TODO update the JSON string below
json = "{}"
# create an instance of Animal from a JSON string
animal_instance = Animal.from_json(json)
# print the JSON string representation of the object
print Animal.to_json()
# convert the object into a dict
animal_dict = animal_instance.to_dict()
# create an instance of Animal from a dict
animal_form_dict = animal.from_dict(animal_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

73
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/AnotherFakeApi.md Normal file
View File

@@ -0,0 +1,73 @@
# petstore_api.AnotherFakeApi
All URIs are relative to *http://petstore.swagger.io:80/v2*
Method | HTTP request | Description
------------- | ------------- | -------------
[**call_123_test_special_tags**](AnotherFakeApi.md#call_123_test_special_tags) | **PATCH** /another-fake/dummy | To test special tags
# **call_123_test_special_tags**
> Client call_123_test_special_tags(client)
To test special tags
To test special tags and operation ID starting with number
### Example
```python
from __future__ import print_function
import time
import os
import petstore_api
from petstore_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://petstore.swagger.io:80/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = petstore_api.Configuration(
host = "http://petstore.swagger.io:80/v2"
)
# Enter a context with an instance of the API client
async with petstore_api.ApiClient() as api_client:
# Create an instance of the API class
api_instance = petstore_api.AnotherFakeApi(api_client)
client = petstore_api.Client() # Client | client model
try:
# To test special tags
api_response = await api_instance.call_123_test_special_tags(client)
print("The response of AnotherFakeApi->call_123_test_special_tags:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling AnotherFakeApi->call_123_test_special_tags: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**client** | [**Client**](Client.md)| client model |
### Return type
[**Client**](Client.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | successful 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)

30
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/AnyOfPig.md Normal file
View File

@@ -0,0 +1,30 @@
# AnyOfPig
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**class_name** | **str** | |
**color** | **str** | |
**size** | **int** | |
## Example
```python
from petstore_api.models.any_of_pig import AnyOfPig
# TODO update the JSON string below
json = "{}"
# create an instance of AnyOfPig from a JSON string
any_of_pig_instance = AnyOfPig.from_json(json)
# print the JSON string representation of the object
print AnyOfPig.to_json()
# convert the object into a dict
any_of_pig_dict = any_of_pig_instance.to_dict()
# create an instance of AnyOfPig from a dict
any_of_pig_form_dict = any_of_pig.from_dict(any_of_pig_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

30
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/ApiResponse.md Normal file
View File

@@ -0,0 +1,30 @@
# ApiResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**code** | **int** | | [optional]
**type** | **str** | | [optional]
**message** | **str** | | [optional]
## Example
```python
from petstore_api.models.api_response import ApiResponse
# TODO update the JSON string below
json = "{}"
# create an instance of ApiResponse from a JSON string
api_response_instance = ApiResponse.from_json(json)
# print the JSON string representation of the object
print ApiResponse.to_json()
# convert the object into a dict
api_response_dict = api_response_instance.to_dict()
# create an instance of ApiResponse from a dict
api_response_form_dict = api_response.from_dict(api_response_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

28
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/ArrayOfArrayOfNumberOnly.md Normal file
View File

@@ -0,0 +1,28 @@
# ArrayOfArrayOfNumberOnly
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**array_array_number** | **List[List[float]]** | | [optional]
## Example
```python
from petstore_api.models.array_of_array_of_number_only import ArrayOfArrayOfNumberOnly
# TODO update the JSON string below
json = "{}"
# create an instance of ArrayOfArrayOfNumberOnly from a JSON string
array_of_array_of_number_only_instance = ArrayOfArrayOfNumberOnly.from_json(json)
# print the JSON string representation of the object
print ArrayOfArrayOfNumberOnly.to_json()
# convert the object into a dict
array_of_array_of_number_only_dict = array_of_array_of_number_only_instance.to_dict()
# create an instance of ArrayOfArrayOfNumberOnly from a dict
array_of_array_of_number_only_form_dict = array_of_array_of_number_only.from_dict(array_of_array_of_number_only_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

28
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/ArrayOfNumberOnly.md Normal file
View File

@@ -0,0 +1,28 @@
# ArrayOfNumberOnly
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**array_number** | **List[float]** | | [optional]
## Example
```python
from petstore_api.models.array_of_number_only import ArrayOfNumberOnly
# TODO update the JSON string below
json = "{}"
# create an instance of ArrayOfNumberOnly from a JSON string
array_of_number_only_instance = ArrayOfNumberOnly.from_json(json)
# print the JSON string representation of the object
print ArrayOfNumberOnly.to_json()
# convert the object into a dict
array_of_number_only_dict = array_of_number_only_instance.to_dict()
# create an instance of ArrayOfNumberOnly from a dict
array_of_number_only_form_dict = array_of_number_only.from_dict(array_of_number_only_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

30
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/ArrayTest.md Normal file
View File

@@ -0,0 +1,30 @@
# ArrayTest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**array_of_string** | **List[str]** | | [optional]
**array_array_of_integer** | **List[List[int]]** | | [optional]
**array_array_of_model** | **List[List[ReadOnlyFirst]]** | | [optional]
## Example
```python
from petstore_api.models.array_test import ArrayTest
# TODO update the JSON string below
json = "{}"
# create an instance of ArrayTest from a JSON string
array_test_instance = ArrayTest.from_json(json)
# print the JSON string representation of the object
print ArrayTest.to_json()
# convert the object into a dict
array_test_dict = array_test_instance.to_dict()
# create an instance of ArrayTest from a dict
array_test_form_dict = array_test.from_dict(array_test_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

29
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/BasquePig.md Normal file
View File

@@ -0,0 +1,29 @@
# BasquePig
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**class_name** | **str** | |
**color** | **str** | |
## Example
```python
from petstore_api.models.basque_pig import BasquePig
# TODO update the JSON string below
json = "{}"
# create an instance of BasquePig from a JSON string
basque_pig_instance = BasquePig.from_json(json)
# print the JSON string representation of the object
print BasquePig.to_json()
# convert the object into a dict
basque_pig_dict = basque_pig_instance.to_dict()
# create an instance of BasquePig from a dict
basque_pig_form_dict = basque_pig.from_dict(basque_pig_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

33
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/Capitalization.md Normal file
View File

@@ -0,0 +1,33 @@
# Capitalization
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**small_camel** | **str** | | [optional]
**capital_camel** | **str** | | [optional]
**small_snake** | **str** | | [optional]
**capital_snake** | **str** | | [optional]
**sca_eth_flow_points** | **str** | | [optional]
**att_name** | **str** | Name of the pet | [optional]
## Example
```python
from petstore_api.models.capitalization import Capitalization
# TODO update the JSON string below
json = "{}"
# create an instance of Capitalization from a JSON string
capitalization_instance = Capitalization.from_json(json)
# print the JSON string representation of the object
print Capitalization.to_json()
# convert the object into a dict
capitalization_dict = capitalization_instance.to_dict()
# create an instance of Capitalization from a dict
capitalization_form_dict = capitalization.from_dict(capitalization_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

28
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/Cat.md Normal file
View File

@@ -0,0 +1,28 @@
# Cat
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**declawed** | **bool** | | [optional]
## Example
```python
from petstore_api.models.cat import Cat
# TODO update the JSON string below
json = "{}"
# create an instance of Cat from a JSON string
cat_instance = Cat.from_json(json)
# print the JSON string representation of the object
print Cat.to_json()
# convert the object into a dict
cat_dict = cat_instance.to_dict()
# create an instance of Cat from a dict
cat_form_dict = cat.from_dict(cat_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

28
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/CatAllOf.md Normal file
View File

@@ -0,0 +1,28 @@
# CatAllOf
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**declawed** | **bool** | | [optional]
## Example
```python
from petstore_api.models.cat_all_of import CatAllOf
# TODO update the JSON string below
json = "{}"
# create an instance of CatAllOf from a JSON string
cat_all_of_instance = CatAllOf.from_json(json)
# print the JSON string representation of the object
print CatAllOf.to_json()
# convert the object into a dict
cat_all_of_dict = cat_all_of_instance.to_dict()
# create an instance of CatAllOf from a dict
cat_all_of_form_dict = cat_all_of.from_dict(cat_all_of_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

29
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/Category.md Normal file
View File

@@ -0,0 +1,29 @@
# Category
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | | [optional]
**name** | **str** | | [default to 'default-name']
## Example
```python
from petstore_api.models.category import Category
# TODO update the JSON string below
json = "{}"
# create an instance of Category from a JSON string
category_instance = Category.from_json(json)
# print the JSON string representation of the object
print Category.to_json()
# convert the object into a dict
category_dict = category_instance.to_dict()
# create an instance of Category from a dict
category_form_dict = category.from_dict(category_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

29
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/ClassModel.md Normal file
View File

@@ -0,0 +1,29 @@
# ClassModel
Model for testing model with \"_class\" property
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**var_class** | **str** | | [optional]
## Example
```python
from petstore_api.models.class_model import ClassModel
# TODO update the JSON string below
json = "{}"
# create an instance of ClassModel from a JSON string
class_model_instance = ClassModel.from_json(json)
# print the JSON string representation of the object
print ClassModel.to_json()
# convert the object into a dict
class_model_dict = class_model_instance.to_dict()
# create an instance of ClassModel from a dict
class_model_form_dict = class_model.from_dict(class_model_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

28
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/Client.md Normal file
View File

@@ -0,0 +1,28 @@
# Client
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**client** | **str** | | [optional]
## Example
```python
from petstore_api.models.client import Client
# TODO update the JSON string below
json = "{}"
# create an instance of Client from a JSON string
client_instance = Client.from_json(json)
# print the JSON string representation of the object
print Client.to_json()
# convert the object into a dict
client_dict = client_instance.to_dict()
# create an instance of Client from a dict
client_form_dict = client.from_dict(client_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

29
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/DanishPig.md Normal file
View File

@@ -0,0 +1,29 @@
# DanishPig
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**class_name** | **str** | |
**size** | **int** | |
## Example
```python
from petstore_api.models.danish_pig import DanishPig
# TODO update the JSON string below
json = "{}"
# create an instance of DanishPig from a JSON string
danish_pig_instance = DanishPig.from_json(json)
# print the JSON string representation of the object
print DanishPig.to_json()
# convert the object into a dict
danish_pig_dict = danish_pig_instance.to_dict()
# create an instance of DanishPig from a dict
danish_pig_form_dict = danish_pig.from_dict(danish_pig_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

66
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/DefaultApi.md Normal file
View File

@@ -0,0 +1,66 @@
# petstore_api.DefaultApi
All URIs are relative to *http://petstore.swagger.io:80/v2*
Method | HTTP request | Description
------------- | ------------- | -------------
[**foo_get**](DefaultApi.md#foo_get) | **GET** /foo |
# **foo_get**
> FooGetDefaultResponse foo_get()
### Example
```python
from __future__ import print_function
import time
import os
import petstore_api
from petstore_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://petstore.swagger.io:80/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = petstore_api.Configuration(
host = "http://petstore.swagger.io:80/v2"
)
# Enter a context with an instance of the API client
async with petstore_api.ApiClient() as api_client:
# Create an instance of the API class
api_instance = petstore_api.DefaultApi(api_client)
try:
api_response = await api_instance.foo_get()
print("The response of DefaultApi->foo_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DefaultApi->foo_get: %s\n" % e)
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**FooGetDefaultResponse**](FooGetDefaultResponse.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **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)

28
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/DeprecatedObject.md Normal file
View File

@@ -0,0 +1,28 @@
# DeprecatedObject
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | | [optional]
## Example
```python
from petstore_api.models.deprecated_object import DeprecatedObject
# TODO update the JSON string below
json = "{}"
# create an instance of DeprecatedObject from a JSON string
deprecated_object_instance = DeprecatedObject.from_json(json)
# print the JSON string representation of the object
print DeprecatedObject.to_json()
# convert the object into a dict
deprecated_object_dict = deprecated_object_instance.to_dict()
# create an instance of DeprecatedObject from a dict
deprecated_object_form_dict = deprecated_object.from_dict(deprecated_object_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

28
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/Dog.md Normal file
View File

@@ -0,0 +1,28 @@
# Dog
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**breed** | **str** | | [optional]
## Example
```python
from petstore_api.models.dog import Dog
# TODO update the JSON string below
json = "{}"
# create an instance of Dog from a JSON string
dog_instance = Dog.from_json(json)
# print the JSON string representation of the object
print Dog.to_json()
# convert the object into a dict
dog_dict = dog_instance.to_dict()
# create an instance of Dog from a dict
dog_form_dict = dog.from_dict(dog_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

28
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/DogAllOf.md Normal file
View File

@@ -0,0 +1,28 @@
# DogAllOf
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**breed** | **str** | | [optional]
## Example
```python
from petstore_api.models.dog_all_of import DogAllOf
# TODO update the JSON string below
json = "{}"
# create an instance of DogAllOf from a JSON string
dog_all_of_instance = DogAllOf.from_json(json)
# print the JSON string representation of the object
print DogAllOf.to_json()
# convert the object into a dict
dog_all_of_dict = dog_all_of_instance.to_dict()
# create an instance of DogAllOf from a dict
dog_all_of_form_dict = dog_all_of.from_dict(dog_all_of_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

29
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/DummyModel.md Normal file
View File

@@ -0,0 +1,29 @@
# DummyModel
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**category** | **str** | | [optional]
**self_ref** | [**SelfReferenceModel**](SelfReferenceModel.md) | | [optional]
## Example
```python
from petstore_api.models.dummy_model import DummyModel
# TODO update the JSON string below
json = "{}"
# create an instance of DummyModel from a JSON string
dummy_model_instance = DummyModel.from_json(json)
# print the JSON string representation of the object
print DummyModel.to_json()
# convert the object into a dict
dummy_model_dict = dummy_model_instance.to_dict()
# create an instance of DummyModel from a dict
dummy_model_form_dict = dummy_model.from_dict(dummy_model_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

29
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/EnumArrays.md Normal file
View File

@@ -0,0 +1,29 @@
# EnumArrays
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**just_symbol** | **str** | | [optional]
**array_enum** | **List[str]** | | [optional]
## Example
```python
from petstore_api.models.enum_arrays import EnumArrays
# TODO update the JSON string below
json = "{}"
# create an instance of EnumArrays from a JSON string
enum_arrays_instance = EnumArrays.from_json(json)
# print the JSON string representation of the object
print EnumArrays.to_json()
# convert the object into a dict
enum_arrays_dict = enum_arrays_instance.to_dict()
# create an instance of EnumArrays from a dict
enum_arrays_form_dict = enum_arrays.from_dict(enum_arrays_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/EnumClass.md Normal file
View File

@@ -0,0 +1,10 @@
# EnumClass
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

35
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/EnumTest.md Normal file
View File

@@ -0,0 +1,35 @@
# EnumTest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**enum_string** | **str** | | [optional]
**enum_string_required** | **str** | |
**enum_integer** | **int** | | [optional]
**enum_number** | **float** | | [optional]
**outer_enum** | [**OuterEnum**](OuterEnum.md) | | [optional]
**outer_enum_integer** | [**OuterEnumInteger**](OuterEnumInteger.md) | | [optional]
**outer_enum_default_value** | [**OuterEnumDefaultValue**](OuterEnumDefaultValue.md) | | [optional]
**outer_enum_integer_default_value** | [**OuterEnumIntegerDefaultValue**](OuterEnumIntegerDefaultValue.md) | | [optional]
## Example
```python
from petstore_api.models.enum_test import EnumTest
# TODO update the JSON string below
json = "{}"
# create an instance of EnumTest from a JSON string
enum_test_instance = EnumTest.from_json(json)
# print the JSON string representation of the object
print EnumTest.to_json()
# convert the object into a dict
enum_test_dict = enum_test_instance.to_dict()
# create an instance of EnumTest from a dict
enum_test_form_dict = enum_test.from_dict(enum_test_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

1153
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/FakeApi.md Normal file
View File

File diff suppressed because it is too large Load Diff

84
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/FakeClassnameTags123Api.md Normal file
View File

@@ -0,0 +1,84 @@
# petstore_api.FakeClassnameTags123Api
All URIs are relative to *http://petstore.swagger.io:80/v2*
Method | HTTP request | Description
------------- | ------------- | -------------
[**test_classname**](FakeClassnameTags123Api.md#test_classname) | **PATCH** /fake_classname_test | To test class name in snake case
# **test_classname**
> Client test_classname(client)
To test class name in snake case
To test class name in snake case
### Example
* Api Key Authentication (api_key_query):
```python
from __future__ import print_function
import time
import os
import petstore_api
from petstore_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://petstore.swagger.io:80/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = petstore_api.Configuration(
host = "http://petstore.swagger.io:80/v2"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: api_key_query
configuration.api_key['api_key_query'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key_query'] = 'Bearer'
# Enter a context with an instance of the API client
async with petstore_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = petstore_api.FakeClassnameTags123Api(api_client)
client = petstore_api.Client() # Client | client model
try:
# To test class name in snake case
api_response = await api_instance.test_classname(client)
print("The response of FakeClassnameTags123Api->test_classname:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling FakeClassnameTags123Api->test_classname: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**client** | [**Client**](Client.md)| client model |
### Return type
[**Client**](Client.md)
### Authorization
[api_key_query](../README.md#api_key_query)
### HTTP request headers
- **Content-Type**: 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)

29
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/File.md Normal file
View File

@@ -0,0 +1,29 @@
# File
Must be named `File` for test.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**source_uri** | **str** | Test capitalization | [optional]
## Example
```python
from petstore_api.models.file import File
# TODO update the JSON string below
json = "{}"
# create an instance of File from a JSON string
file_instance = File.from_json(json)
# print the JSON string representation of the object
print File.to_json()
# convert the object into a dict
file_dict = file_instance.to_dict()
# create an instance of File from a dict
file_form_dict = file.from_dict(file_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

29
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/FileSchemaTestClass.md Normal file
View File

@@ -0,0 +1,29 @@
# FileSchemaTestClass
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**file** | [**File**](File.md) | | [optional]
**files** | [**List[File]**](File.md) | | [optional]
## Example
```python
from petstore_api.models.file_schema_test_class import FileSchemaTestClass
# TODO update the JSON string below
json = "{}"
# create an instance of FileSchemaTestClass from a JSON string
file_schema_test_class_instance = FileSchemaTestClass.from_json(json)
# print the JSON string representation of the object
print FileSchemaTestClass.to_json()
# convert the object into a dict
file_schema_test_class_dict = file_schema_test_class_instance.to_dict()
# create an instance of FileSchemaTestClass from a dict
file_schema_test_class_form_dict = file_schema_test_class.from_dict(file_schema_test_class_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

28
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/Foo.md Normal file
View File

@@ -0,0 +1,28 @@
# Foo
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**bar** | **str** | | [optional] [default to 'bar']
## Example
```python
from petstore_api.models.foo import Foo
# TODO update the JSON string below
json = "{}"
# create an instance of Foo from a JSON string
foo_instance = Foo.from_json(json)
# print the JSON string representation of the object
print Foo.to_json()
# convert the object into a dict
foo_dict = foo_instance.to_dict()
# create an instance of Foo from a dict
foo_form_dict = foo.from_dict(foo_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

28
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/FooGetDefaultResponse.md Normal file
View File

@@ -0,0 +1,28 @@
# FooGetDefaultResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**string** | [**Foo**](Foo.md) | | [optional]
## Example
```python
from petstore_api.models.foo_get_default_response import FooGetDefaultResponse
# TODO update the JSON string below
json = "{}"
# create an instance of FooGetDefaultResponse from a JSON string
foo_get_default_response_instance = FooGetDefaultResponse.from_json(json)
# print the JSON string representation of the object
print FooGetDefaultResponse.to_json()
# convert the object into a dict
foo_get_default_response_dict = foo_get_default_response_instance.to_dict()
# create an instance of FooGetDefaultResponse from a dict
foo_get_default_response_form_dict = foo_get_default_response.from_dict(foo_get_default_response_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

43
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/FormatTest.md Normal file
View File

@@ -0,0 +1,43 @@
# FormatTest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**integer** | **int** | | [optional]
**int32** | **int** | | [optional]
**int64** | **int** | | [optional]
**number** | **float** | |
**float** | **float** | | [optional]
**double** | **float** | | [optional]
**decimal** | **decimal.Decimal** | | [optional]
**string** | **str** | | [optional]
**byte** | **str** | |
**binary** | **str** | | [optional]
**var_date** | **date** | |
**date_time** | **datetime** | | [optional]
**uuid** | **str** | | [optional]
**password** | **str** | |
**pattern_with_digits** | **str** | A string that is a 10 digit number. Can have leading zeros. | [optional]
**pattern_with_digits_and_delimiter** | **str** | A string starting with 'image_' (case insensitive) and one to three digits following i.e. Image_01. | [optional]
## Example
```python
from petstore_api.models.format_test import FormatTest
# TODO update the JSON string below
json = "{}"
# create an instance of FormatTest from a JSON string
format_test_instance = FormatTest.from_json(json)
# print the JSON string representation of the object
print FormatTest.to_json()
# convert the object into a dict
format_test_dict = format_test_instance.to_dict()
# create an instance of FormatTest from a dict
format_test_form_dict = format_test.from_dict(format_test_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

29
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/HasOnlyReadOnly.md Normal file
View File

@@ -0,0 +1,29 @@
# HasOnlyReadOnly
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**bar** | **str** | | [optional] [readonly]
**foo** | **str** | | [optional] [readonly]
## Example
```python
from petstore_api.models.has_only_read_only import HasOnlyReadOnly
# TODO update the JSON string below
json = "{}"
# create an instance of HasOnlyReadOnly from a JSON string
has_only_read_only_instance = HasOnlyReadOnly.from_json(json)
# print the JSON string representation of the object
print HasOnlyReadOnly.to_json()
# convert the object into a dict
has_only_read_only_dict = has_only_read_only_instance.to_dict()
# create an instance of HasOnlyReadOnly from a dict
has_only_read_only_form_dict = has_only_read_only.from_dict(has_only_read_only_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

29
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/HealthCheckResult.md Normal file
View File

@@ -0,0 +1,29 @@
# HealthCheckResult
Just a string to inform instance is up and running. Make it nullable in hope to get it as pointer in generated model.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**nullable_message** | **str** | | [optional]
## Example
```python
from petstore_api.models.health_check_result import HealthCheckResult
# TODO update the JSON string below
json = "{}"
# create an instance of HealthCheckResult from a JSON string
health_check_result_instance = HealthCheckResult.from_json(json)
# print the JSON string representation of the object
print HealthCheckResult.to_json()
# convert the object into a dict
health_check_result_dict = health_check_result_instance.to_dict()
# create an instance of HealthCheckResult from a dict
health_check_result_form_dict = health_check_result.from_dict(health_check_result_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

28
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/List.md Normal file
View File

@@ -0,0 +1,28 @@
# List
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**var_123_list** | **str** | | [optional]
## Example
```python
from petstore_api.models.list import List
# TODO update the JSON string below
json = "{}"
# create an instance of List from a JSON string
list_instance = List.from_json(json)
# print the JSON string representation of the object
print List.to_json()
# convert the object into a dict
list_dict = list_instance.to_dict()
# create an instance of List from a dict
list_form_dict = list.from_dict(list_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

31
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/MapTest.md Normal file
View File

@@ -0,0 +1,31 @@
# MapTest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**map_map_of_string** | **Dict[str, Dict[str, str]]** | | [optional]
**map_of_enum_string** | **Dict[str, str]** | | [optional]
**direct_map** | **Dict[str, bool]** | | [optional]
**indirect_map** | **Dict[str, bool]** | | [optional]
## Example
```python
from petstore_api.models.map_test import MapTest
# TODO update the JSON string below
json = "{}"
# create an instance of MapTest from a JSON string
map_test_instance = MapTest.from_json(json)
# print the JSON string representation of the object
print MapTest.to_json()
# convert the object into a dict
map_test_dict = map_test_instance.to_dict()
# create an instance of MapTest from a dict
map_test_form_dict = map_test.from_dict(map_test_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

30
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/MixedPropertiesAndAdditionalPropertiesClass.md Normal file
View File

@@ -0,0 +1,30 @@
# MixedPropertiesAndAdditionalPropertiesClass
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**uuid** | **str** | | [optional]
**date_time** | **datetime** | | [optional]
**map** | [**Dict[str, Animal]**](Animal.md) | | [optional]
## Example
```python
from petstore_api.models.mixed_properties_and_additional_properties_class import MixedPropertiesAndAdditionalPropertiesClass
# TODO update the JSON string below
json = "{}"
# create an instance of MixedPropertiesAndAdditionalPropertiesClass from a JSON string
mixed_properties_and_additional_properties_class_instance = MixedPropertiesAndAdditionalPropertiesClass.from_json(json)
# print the JSON string representation of the object
print MixedPropertiesAndAdditionalPropertiesClass.to_json()
# convert the object into a dict
mixed_properties_and_additional_properties_class_dict = mixed_properties_and_additional_properties_class_instance.to_dict()
# create an instance of MixedPropertiesAndAdditionalPropertiesClass from a dict
mixed_properties_and_additional_properties_class_form_dict = mixed_properties_and_additional_properties_class.from_dict(mixed_properties_and_additional_properties_class_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

30
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/Model200Response.md Normal file
View File

@@ -0,0 +1,30 @@
# Model200Response
Model for testing model name starting with number
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **int** | | [optional]
**var_class** | **str** | | [optional]
## Example
```python
from petstore_api.models.model200_response import Model200Response
# TODO update the JSON string below
json = "{}"
# create an instance of Model200Response from a JSON string
model200_response_instance = Model200Response.from_json(json)
# print the JSON string representation of the object
print Model200Response.to_json()
# convert the object into a dict
model200_response_dict = model200_response_instance.to_dict()
# create an instance of Model200Response from a dict
model200_response_form_dict = model200_response.from_dict(model200_response_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

29
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/ModelReturn.md Normal file
View File

@@ -0,0 +1,29 @@
# ModelReturn
Model for testing reserved words
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**var_return** | **int** | | [optional]
## Example
```python
from petstore_api.models.model_return import ModelReturn
# TODO update the JSON string below
json = "{}"
# create an instance of ModelReturn from a JSON string
model_return_instance = ModelReturn.from_json(json)
# print the JSON string representation of the object
print ModelReturn.to_json()
# convert the object into a dict
model_return_dict = model_return_instance.to_dict()
# create an instance of ModelReturn from a dict
model_return_form_dict = model_return.from_dict(model_return_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

32
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/Name.md Normal file
View File

@@ -0,0 +1,32 @@
# Name
Model for testing model name same as property name
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **int** | |
**snake_case** | **int** | | [optional] [readonly]
**var_property** | **str** | | [optional]
**var_123_number** | **int** | | [optional] [readonly]
## Example
```python
from petstore_api.models.name import Name
# TODO update the JSON string below
json = "{}"
# create an instance of Name from a JSON string
name_instance = Name.from_json(json)
# print the JSON string representation of the object
print Name.to_json()
# convert the object into a dict
name_dict = name_instance.to_dict()
# create an instance of Name from a dict
name_form_dict = name.from_dict(name_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

40
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/NullableClass.md Normal file
View File

@@ -0,0 +1,40 @@
# NullableClass
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**required_integer_prop** | **int** | |
**integer_prop** | **int** | | [optional]
**number_prop** | **float** | | [optional]
**boolean_prop** | **bool** | | [optional]
**string_prop** | **str** | | [optional]
**date_prop** | **date** | | [optional]
**datetime_prop** | **datetime** | | [optional]
**array_nullable_prop** | **List[object]** | | [optional]
**array_and_items_nullable_prop** | **List[object]** | | [optional]
**array_items_nullable** | **List[object]** | | [optional]
**object_nullable_prop** | **Dict[str, object]** | | [optional]
**object_and_items_nullable_prop** | **Dict[str, object]** | | [optional]
**object_items_nullable** | **Dict[str, object]** | | [optional]
## Example
```python
from petstore_api.models.nullable_class import NullableClass
# TODO update the JSON string below
json = "{}"
# create an instance of NullableClass from a JSON string
nullable_class_instance = NullableClass.from_json(json)
# print the JSON string representation of the object
print NullableClass.to_json()
# convert the object into a dict
nullable_class_dict = nullable_class_instance.to_dict()
# create an instance of NullableClass from a dict
nullable_class_form_dict = nullable_class.from_dict(nullable_class_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

28
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/NumberOnly.md Normal file
View File

@@ -0,0 +1,28 @@
# NumberOnly
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**just_number** | **float** | | [optional]
## Example
```python
from petstore_api.models.number_only import NumberOnly
# TODO update the JSON string below
json = "{}"
# create an instance of NumberOnly from a JSON string
number_only_instance = NumberOnly.from_json(json)
# print the JSON string representation of the object
print NumberOnly.to_json()
# convert the object into a dict
number_only_dict = number_only_instance.to_dict()
# create an instance of NumberOnly from a dict
number_only_form_dict = number_only.from_dict(number_only_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

31
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/ObjectWithDeprecatedFields.md Normal file
View File

@@ -0,0 +1,31 @@
# ObjectWithDeprecatedFields
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**uuid** | **str** | | [optional]
**id** | **float** | | [optional]
**deprecated_ref** | [**DeprecatedObject**](DeprecatedObject.md) | | [optional]
**bars** | **List[str]** | | [optional]
## Example
```python
from petstore_api.models.object_with_deprecated_fields import ObjectWithDeprecatedFields
# TODO update the JSON string below
json = "{}"
# create an instance of ObjectWithDeprecatedFields from a JSON string
object_with_deprecated_fields_instance = ObjectWithDeprecatedFields.from_json(json)
# print the JSON string representation of the object
print ObjectWithDeprecatedFields.to_json()
# convert the object into a dict
object_with_deprecated_fields_dict = object_with_deprecated_fields_instance.to_dict()
# create an instance of ObjectWithDeprecatedFields from a dict
object_with_deprecated_fields_form_dict = object_with_deprecated_fields.from_dict(object_with_deprecated_fields_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

33
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/Order.md Normal file
View File

@@ -0,0 +1,33 @@
# Order
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | | [optional]
**pet_id** | **int** | | [optional]
**quantity** | **int** | | [optional]
**ship_date** | **datetime** | | [optional]
**status** | **str** | Order Status | [optional]
**complete** | **bool** | | [optional] [default to False]
## Example
```python
from petstore_api.models.order import Order
# TODO update the JSON string below
json = "{}"
# create an instance of Order from a JSON string
order_instance = Order.from_json(json)
# print the JSON string representation of the object
print Order.to_json()
# convert the object into a dict
order_dict = order_instance.to_dict()
# create an instance of Order from a dict
order_form_dict = order.from_dict(order_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

30
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/OuterComposite.md Normal file
View File

@@ -0,0 +1,30 @@
# OuterComposite
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**my_number** | **float** | | [optional]
**my_string** | **str** | | [optional]
**my_boolean** | **bool** | | [optional]
## Example
```python
from petstore_api.models.outer_composite import OuterComposite
# TODO update the JSON string below
json = "{}"
# create an instance of OuterComposite from a JSON string
outer_composite_instance = OuterComposite.from_json(json)
# print the JSON string representation of the object
print OuterComposite.to_json()
# convert the object into a dict
outer_composite_dict = outer_composite_instance.to_dict()
# create an instance of OuterComposite from a dict
outer_composite_form_dict = outer_composite.from_dict(outer_composite_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/OuterEnum.md Normal file
View File

@@ -0,0 +1,10 @@
# OuterEnum
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/OuterEnumDefaultValue.md Normal file
View File

@@ -0,0 +1,10 @@
# OuterEnumDefaultValue
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/OuterEnumInteger.md Normal file
View File

@@ -0,0 +1,10 @@
# OuterEnumInteger
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/OuterEnumIntegerDefaultValue.md Normal file
View File

@@ -0,0 +1,10 @@
# OuterEnumIntegerDefaultValue
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

29
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/OuterObjectWithEnumProperty.md Normal file
View File

@@ -0,0 +1,29 @@
# OuterObjectWithEnumProperty
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**str_value** | [**OuterEnum**](OuterEnum.md) | | [optional]
**value** | [**OuterEnumInteger**](OuterEnumInteger.md) | |
## Example
```python
from petstore_api.models.outer_object_with_enum_property import OuterObjectWithEnumProperty
# TODO update the JSON string below
json = "{}"
# create an instance of OuterObjectWithEnumProperty from a JSON string
outer_object_with_enum_property_instance = OuterObjectWithEnumProperty.from_json(json)
# print the JSON string representation of the object
print OuterObjectWithEnumProperty.to_json()
# convert the object into a dict
outer_object_with_enum_property_dict = outer_object_with_enum_property_instance.to_dict()
# create an instance of OuterObjectWithEnumProperty from a dict
outer_object_with_enum_property_form_dict = outer_object_with_enum_property.from_dict(outer_object_with_enum_property_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

33
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/Pet.md Normal file
View File

@@ -0,0 +1,33 @@
# Pet
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | | [optional]
**category** | [**Category**](Category.md) | | [optional]
**name** | **str** | |
**photo_urls** | **List[str]** | |
**tags** | [**List[Tag]**](Tag.md) | | [optional]
**status** | **str** | pet status in the store | [optional]
## Example
```python
from petstore_api.models.pet import Pet
# TODO update the JSON string below
json = "{}"
# create an instance of Pet from a JSON string
pet_instance = Pet.from_json(json)
# print the JSON string representation of the object
print Pet.to_json()
# convert the object into a dict
pet_dict = pet_instance.to_dict()
# create an instance of Pet from a dict
pet_form_dict = pet.from_dict(pet_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

1292
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/PetApi.md Normal file
View File

File diff suppressed because it is too large Load Diff

30
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/Pig.md Normal file
View File

@@ -0,0 +1,30 @@
# Pig
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**class_name** | **str** | |
**color** | **str** | |
**size** | **int** | |
## Example
```python
from petstore_api.models.pig import Pig
# TODO update the JSON string below
json = "{}"
# create an instance of Pig from a JSON string
pig_instance = Pig.from_json(json)
# print the JSON string representation of the object
print Pig.to_json()
# convert the object into a dict
pig_dict = pig_instance.to_dict()
# create an instance of Pig from a dict
pig_form_dict = pig.from_dict(pig_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

29
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/ReadOnlyFirst.md Normal file
View File

@@ -0,0 +1,29 @@
# ReadOnlyFirst
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**bar** | **str** | | [optional] [readonly]
**baz** | **str** | | [optional]
## Example
```python
from petstore_api.models.read_only_first import ReadOnlyFirst
# TODO update the JSON string below
json = "{}"
# create an instance of ReadOnlyFirst from a JSON string
read_only_first_instance = ReadOnlyFirst.from_json(json)
# print the JSON string representation of the object
print ReadOnlyFirst.to_json()
# convert the object into a dict
read_only_first_dict = read_only_first_instance.to_dict()
# create an instance of ReadOnlyFirst from a dict
read_only_first_form_dict = read_only_first.from_dict(read_only_first_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

29
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/SelfReferenceModel.md Normal file
View File

@@ -0,0 +1,29 @@
# SelfReferenceModel
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**size** | **int** | | [optional]
**nested** | [**DummyModel**](DummyModel.md) | | [optional]
## Example
```python
from petstore_api.models.self_reference_model import SelfReferenceModel
# TODO update the JSON string below
json = "{}"
# create an instance of SelfReferenceModel from a JSON string
self_reference_model_instance = SelfReferenceModel.from_json(json)
# print the JSON string representation of the object
print SelfReferenceModel.to_json()
# convert the object into a dict
self_reference_model_dict = self_reference_model_instance.to_dict()
# create an instance of SelfReferenceModel from a dict
self_reference_model_form_dict = self_reference_model.from_dict(self_reference_model_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/SingleRefType.md Normal file
View File

@@ -0,0 +1,10 @@
# SingleRefType
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

28
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/SpecialModelName.md Normal file
View File

@@ -0,0 +1,28 @@
# SpecialModelName
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**special_property_name** | **int** | | [optional]
## Example
```python
from petstore_api.models.special_model_name import SpecialModelName
# TODO update the JSON string below
json = "{}"
# create an instance of SpecialModelName from a JSON string
special_model_name_instance = SpecialModelName.from_json(json)
# print the JSON string representation of the object
print SpecialModelName.to_json()
# convert the object into a dict
special_model_name_dict = special_model_name_instance.to_dict()
# create an instance of SpecialModelName from a dict
special_model_name_form_dict = special_model_name.from_dict(special_model_name_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

30
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/SpecialName.md Normal file
View File

@@ -0,0 +1,30 @@
# SpecialName
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**var_property** | **int** | | [optional]
**var_async** | [**Category**](Category.md) | | [optional]
**var_schema** | **str** | pet status in the store | [optional]
## Example
```python
from petstore_api.models.special_name import SpecialName
# TODO update the JSON string below
json = "{}"
# create an instance of SpecialName from a JSON string
special_name_instance = SpecialName.from_json(json)
# print the JSON string representation of the object
print SpecialName.to_json()
# convert the object into a dict
special_name_dict = special_name_instance.to_dict()
# create an instance of SpecialName from a dict
special_name_form_dict = special_name.from_dict(special_name_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

277
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/StoreApi.md Normal file
View File

@@ -0,0 +1,277 @@
# petstore_api.StoreApi
All URIs are relative to *http://petstore.swagger.io:80/v2*
Method | HTTP request | Description
------------- | ------------- | -------------
[**delete_order**](StoreApi.md#delete_order) | **DELETE** /store/order/{order_id} | Delete purchase order by ID
[**get_inventory**](StoreApi.md#get_inventory) | **GET** /store/inventory | Returns pet inventories by status
[**get_order_by_id**](StoreApi.md#get_order_by_id) | **GET** /store/order/{order_id} | Find purchase order by ID
[**place_order**](StoreApi.md#place_order) | **POST** /store/order | Place an order for a pet
# **delete_order**
> delete_order(order_id)
Delete purchase order by ID
For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
### Example
```python
from __future__ import print_function
import time
import os
import petstore_api
from petstore_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://petstore.swagger.io:80/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = petstore_api.Configuration(
host = "http://petstore.swagger.io:80/v2"
)
# Enter a context with an instance of the API client
async with petstore_api.ApiClient() as api_client:
# Create an instance of the API class
api_instance = petstore_api.StoreApi(api_client)
order_id = 'order_id_example' # str | ID of the order that needs to be deleted
try:
# Delete purchase order by ID
await api_instance.delete_order(order_id)
except Exception as e:
print("Exception when calling StoreApi->delete_order: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**order_id** | **str**| ID of the order that needs to be deleted |
### Return type
void (empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: 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)
# **get_inventory**
> Dict[str, int] get_inventory()
Returns pet inventories by status
Returns a map of status codes to quantities
### Example
* Api Key Authentication (api_key):
```python
from __future__ import print_function
import time
import os
import petstore_api
from petstore_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://petstore.swagger.io:80/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = petstore_api.Configuration(
host = "http://petstore.swagger.io:80/v2"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Enter a context with an instance of the API client
async with petstore_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = petstore_api.StoreApi(api_client)
try:
# Returns pet inventories by status
api_response = await api_instance.get_inventory()
print("The response of StoreApi->get_inventory:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling StoreApi->get_inventory: %s\n" % e)
```
### Parameters
This endpoint does not need any parameter.
### Return type
**Dict[str, int]**
### Authorization
[api_key](../README.md#api_key)
### HTTP request headers
- **Content-Type**: Not defined
- **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)
# **get_order_by_id**
> Order get_order_by_id(order_id)
Find purchase order by ID
For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions
### Example
```python
from __future__ import print_function
import time
import os
import petstore_api
from petstore_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://petstore.swagger.io:80/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = petstore_api.Configuration(
host = "http://petstore.swagger.io:80/v2"
)
# Enter a context with an instance of the API client
async with petstore_api.ApiClient() as api_client:
# Create an instance of the API class
api_instance = petstore_api.StoreApi(api_client)
order_id = 56 # int | ID of pet that needs to be fetched
try:
# Find purchase order by ID
api_response = await api_instance.get_order_by_id(order_id)
print("The response of StoreApi->get_order_by_id:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling StoreApi->get_order_by_id: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**order_id** | **int**| ID of pet that needs to be fetched |
### Return type
[**Order**](Order.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **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)
# **place_order**
> Order place_order(order)
Place an order for a pet
### Example
```python
from __future__ import print_function
import time
import os
import petstore_api
from petstore_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://petstore.swagger.io:80/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = petstore_api.Configuration(
host = "http://petstore.swagger.io:80/v2"
)
# Enter a context with an instance of the API client
async with petstore_api.ApiClient() as api_client:
# Create an instance of the API class
api_instance = petstore_api.StoreApi(api_client)
order = petstore_api.Order() # Order | order placed for purchasing the pet
try:
# Place an order for a pet
api_response = await api_instance.place_order(order)
print("The response of StoreApi->place_order:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling StoreApi->place_order: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**order** | [**Order**](Order.md)| order placed for purchasing the pet |
### Return type
[**Order**](Order.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: 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)

29
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/Tag.md Normal file
View File

@@ -0,0 +1,29 @@
# Tag
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | | [optional]
**name** | **str** | | [optional]
## Example
```python
from petstore_api.models.tag import Tag
# TODO update the JSON string below
json = "{}"
# create an instance of Tag from a JSON string
tag_instance = Tag.from_json(json)
# print the JSON string representation of the object
print Tag.to_json()
# convert the object into a dict
tag_dict = tag_instance.to_dict()
# create an instance of Tag from a dict
tag_form_dict = tag.from_dict(tag_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

35
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/User.md Normal file
View File

@@ -0,0 +1,35 @@
# User
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | | [optional]
**username** | **str** | | [optional]
**first_name** | **str** | | [optional]
**last_name** | **str** | | [optional]
**email** | **str** | | [optional]
**password** | **str** | | [optional]
**phone** | **str** | | [optional]
**user_status** | **int** | User Status | [optional]
## Example
```python
from petstore_api.models.user import User
# TODO update the JSON string below
json = "{}"
# create an instance of User from a JSON string
user_instance = User.from_json(json)
# print the JSON string representation of the object
print User.to_json()
# convert the object into a dict
user_dict = user_instance.to_dict()
# create an instance of User from a dict
user_form_dict = user.from_dict(user_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

521
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/UserApi.md Normal file
View File

@@ -0,0 +1,521 @@
# petstore_api.UserApi
All URIs are relative to *http://petstore.swagger.io:80/v2*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create_user**](UserApi.md#create_user) | **POST** /user | Create user
[**create_users_with_array_input**](UserApi.md#create_users_with_array_input) | **POST** /user/createWithArray | Creates list of users with given input array
[**create_users_with_list_input**](UserApi.md#create_users_with_list_input) | **POST** /user/createWithList | Creates list of users with given input array
[**delete_user**](UserApi.md#delete_user) | **DELETE** /user/{username} | Delete user
[**get_user_by_name**](UserApi.md#get_user_by_name) | **GET** /user/{username} | Get user by user name
[**login_user**](UserApi.md#login_user) | **GET** /user/login | Logs user into the system
[**logout_user**](UserApi.md#logout_user) | **GET** /user/logout | Logs out current logged in user session
[**update_user**](UserApi.md#update_user) | **PUT** /user/{username} | Updated user
# **create_user**
> create_user(user)
Create user
This can only be done by the logged in user.
### Example
```python
from __future__ import print_function
import time
import os
import petstore_api
from petstore_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://petstore.swagger.io:80/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = petstore_api.Configuration(
host = "http://petstore.swagger.io:80/v2"
)
# Enter a context with an instance of the API client
async with petstore_api.ApiClient() as api_client:
# Create an instance of the API class
api_instance = petstore_api.UserApi(api_client)
user = petstore_api.User() # User | Created user object
try:
# Create user
await api_instance.create_user(user)
except Exception as e:
print("Exception when calling UserApi->create_user: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**user** | [**User**](User.md)| Created user object |
### Return type
void (empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **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)
# **create_users_with_array_input**
> create_users_with_array_input(user)
Creates list of users with given input array
### Example
```python
from __future__ import print_function
import time
import os
import petstore_api
from petstore_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://petstore.swagger.io:80/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = petstore_api.Configuration(
host = "http://petstore.swagger.io:80/v2"
)
# Enter a context with an instance of the API client
async with petstore_api.ApiClient() as api_client:
# Create an instance of the API class
api_instance = petstore_api.UserApi(api_client)
user = [petstore_api.User()] # List[User] | List of user object
try:
# Creates list of users with given input array
await api_instance.create_users_with_array_input(user)
except Exception as e:
print("Exception when calling UserApi->create_users_with_array_input: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**user** | [**List[User]**](User.md)| List of user object |
### Return type
void (empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **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)
# **create_users_with_list_input**
> create_users_with_list_input(user)
Creates list of users with given input array
### Example
```python
from __future__ import print_function
import time
import os
import petstore_api
from petstore_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://petstore.swagger.io:80/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = petstore_api.Configuration(
host = "http://petstore.swagger.io:80/v2"
)
# Enter a context with an instance of the API client
async with petstore_api.ApiClient() as api_client:
# Create an instance of the API class
api_instance = petstore_api.UserApi(api_client)
user = [petstore_api.User()] # List[User] | List of user object
try:
# Creates list of users with given input array
await api_instance.create_users_with_list_input(user)
except Exception as e:
print("Exception when calling UserApi->create_users_with_list_input: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**user** | [**List[User]**](User.md)| List of user object |
### Return type
void (empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **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)
# **delete_user**
> delete_user(username)
Delete user
This can only be done by the logged in user.
### Example
```python
from __future__ import print_function
import time
import os
import petstore_api
from petstore_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://petstore.swagger.io:80/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = petstore_api.Configuration(
host = "http://petstore.swagger.io:80/v2"
)
# Enter a context with an instance of the API client
async with petstore_api.ApiClient() as api_client:
# Create an instance of the API class
api_instance = petstore_api.UserApi(api_client)
username = 'username_example' # str | The name that needs to be deleted
try:
# Delete user
await api_instance.delete_user(username)
except Exception as e:
print("Exception when calling UserApi->delete_user: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **str**| The name that needs to be deleted |
### Return type
void (empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: 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)
# **get_user_by_name**
> User get_user_by_name(username)
Get user by user name
### Example
```python
from __future__ import print_function
import time
import os
import petstore_api
from petstore_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://petstore.swagger.io:80/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = petstore_api.Configuration(
host = "http://petstore.swagger.io:80/v2"
)
# Enter a context with an instance of the API client
async with petstore_api.ApiClient() as api_client:
# Create an instance of the API class
api_instance = petstore_api.UserApi(api_client)
username = 'username_example' # str | The name that needs to be fetched. Use user1 for testing.
try:
# Get user by user name
api_response = await api_instance.get_user_by_name(username)
print("The response of UserApi->get_user_by_name:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling UserApi->get_user_by_name: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **str**| The name that needs to be fetched. Use user1 for testing. |
### Return type
[**User**](User.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **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)
# **login_user**
> str login_user(username, password)
Logs user into the system
### Example
```python
from __future__ import print_function
import time
import os
import petstore_api
from petstore_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://petstore.swagger.io:80/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = petstore_api.Configuration(
host = "http://petstore.swagger.io:80/v2"
)
# Enter a context with an instance of the API client
async with petstore_api.ApiClient() as api_client:
# Create an instance of the API class
api_instance = petstore_api.UserApi(api_client)
username = 'username_example' # str | The user name for login
password = 'password_example' # str | The password for login in clear text
try:
# Logs user into the system
api_response = await api_instance.login_user(username, password)
print("The response of UserApi->login_user:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling UserApi->login_user: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **str**| The user name for login |
**password** | **str**| The password for login in clear text |
### Return type
**str**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **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)
# **logout_user**
> logout_user()
Logs out current logged in user session
### Example
```python
from __future__ import print_function
import time
import os
import petstore_api
from petstore_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://petstore.swagger.io:80/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = petstore_api.Configuration(
host = "http://petstore.swagger.io:80/v2"
)
# Enter a context with an instance of the API client
async with petstore_api.ApiClient() as api_client:
# Create an instance of the API class
api_instance = petstore_api.UserApi(api_client)
try:
# Logs out current logged in user session
await api_instance.logout_user()
except Exception as e:
print("Exception when calling UserApi->logout_user: %s\n" % e)
```
### Parameters
This endpoint does not need any parameter.
### Return type
void (empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: 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)
# **update_user**
> update_user(username, user)
Updated user
This can only be done by the logged in user.
### Example
```python
from __future__ import print_function
import time
import os
import petstore_api
from petstore_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://petstore.swagger.io:80/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = petstore_api.Configuration(
host = "http://petstore.swagger.io:80/v2"
)
# Enter a context with an instance of the API client
async with petstore_api.ApiClient() as api_client:
# Create an instance of the API class
api_instance = petstore_api.UserApi(api_client)
username = 'username_example' # str | name that need to be deleted
user = petstore_api.User() # User | Updated user object
try:
# Updated user
await api_instance.update_user(username, user)
except Exception as e:
print("Exception when calling UserApi->update_user: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **str**| name that need to be deleted |
**user** | [**User**](User.md)| Updated user object |
### Return type
void (empty response body)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **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)

29
samples/openapi3/client/petstore/python-nextgen-aiohttp/docs/WithNestedOneOf.md Normal file
View File

@@ -0,0 +1,29 @@
# WithNestedOneOf
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**size** | **int** | | [optional]
**nested_pig** | [**Pig**](Pig.md) | | [optional]
## Example
```python
from petstore_api.models.with_nested_one_of import WithNestedOneOf
# TODO update the JSON string below
json = "{}"
# create an instance of WithNestedOneOf from a JSON string
with_nested_one_of_instance = WithNestedOneOf.from_json(json)
# print the JSON string representation of the object
print WithNestedOneOf.to_json()
# convert the object into a dict
with_nested_one_of_dict = with_nested_one_of_instance.to_dict()
# create an instance of WithNestedOneOf from a dict
with_nested_one_of_form_dict = with_nested_one_of.from_dict(with_nested_one_of_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)