mirror of
https://github.com/OpenAPITools/openapi-generator.git
synced 2025-10-13 16:03:43 +00:00
[python] add async httpx support (#22021)
* [python] fix #19255 add async httpx support * update docs * 1. "async" parameter for templates 2. hand written tests for python-httpx 3. CI workflow updated * fix mypy
This commit is contained in:
Alex Kondratev
GitHub
parent
c1931c10da
commit
bab5ca2452
@ -34,6 +34,7 @@ jobs:
|
||||
- "3.13"
|
||||
sample:
|
||||
- samples/openapi3/client/petstore/python-aiohttp
|
||||
- samples/openapi3/client/petstore/python-httpx
|
||||
- samples/openapi3/client/petstore/python
|
||||
- samples/openapi3/client/petstore/python-lazyImports
|
||||
services:
|
||||
|
||||
15
bin/configs/python-httpx.yaml
Normal file
15
bin/configs/python-httpx.yaml
Normal file
@ -0,0 +1,15 @@
|
||||
generatorName: python
|
||||
outputDir: samples/openapi3/client/petstore/python-httpx
|
||||
inputSpec: modules/openapi-generator/src/test/resources/3_0/python/petstore-with-fake-endpoints-models-for-testing.yaml
|
||||
templateDir: modules/openapi-generator/src/main/resources/python
|
||||
library: httpx
|
||||
additionalProperties:
|
||||
packageName: petstore_api
|
||||
mapNumberTo: float
|
||||
poetry1: true
|
||||
nameMappings:
|
||||
_type: underscore_type
|
||||
type_: type_with_underscore
|
||||
modelNameMappings:
|
||||
# The OpenAPI spec ApiResponse conflicts with the internal ApiResponse
|
||||
ApiResponse: ModelApiResponse
|
||||
@ -25,7 +25,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|
||||
|generateSourceCodeOnly|Specifies that only a library source code is to be generated.| |false|
|
||||
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true|
|
||||
|lazyImports|Enable lazy imports.| |false|
|
||||
|library|library template (sub-template) to use: asyncio, tornado (deprecated), urllib3| |urllib3|
|
||||
|library|library template (sub-template) to use: asyncio, tornado (deprecated), urllib3, httpx| |urllib3|
|
||||
|mapNumberTo|Map number to Union[StrictFloat, StrictInt], StrictStr or float.| |Union[StrictFloat, StrictInt]|
|
||||
|packageName|python package name (convention: snake_case).| |openapi_client|
|
||||
|packageUrl|python package URL.| |null|
|
||||
|
||||
@ -157,7 +157,8 @@ public class PythonClientCodegen extends AbstractPythonCodegen implements Codege
|
||||
supportedLibraries.put("urllib3", "urllib3-based client");
|
||||
supportedLibraries.put("asyncio", "asyncio-based client");
|
||||
supportedLibraries.put("tornado", "tornado-based client (deprecated)");
|
||||
CliOption libraryOption = new CliOption(CodegenConstants.LIBRARY, "library template (sub-template) to use: asyncio, tornado (deprecated), urllib3");
|
||||
supportedLibraries.put("httpx", "httpx-based client");
|
||||
CliOption libraryOption = new CliOption(CodegenConstants.LIBRARY, "library template (sub-template) to use: asyncio, tornado (deprecated), urllib3, httpx");
|
||||
libraryOption.setDefault(DEFAULT_LIBRARY);
|
||||
cliOptions.add(libraryOption);
|
||||
setLibrary(DEFAULT_LIBRARY);
|
||||
@ -330,10 +331,15 @@ public class PythonClientCodegen extends AbstractPythonCodegen implements Codege
|
||||
|
||||
if ("asyncio".equals(getLibrary())) {
|
||||
supportingFiles.add(new SupportingFile("asyncio/rest.mustache", packagePath(), "rest.py"));
|
||||
additionalProperties.put("async", "true");
|
||||
additionalProperties.put("asyncio", "true");
|
||||
} else if ("tornado".equals(getLibrary())) {
|
||||
supportingFiles.add(new SupportingFile("tornado/rest.mustache", packagePath(), "rest.py"));
|
||||
additionalProperties.put("tornado", "true");
|
||||
} else if ("httpx".equals(getLibrary())) {
|
||||
supportingFiles.add(new SupportingFile("httpx/rest.mustache", packagePath(), "rest.py"));
|
||||
additionalProperties.put("async", "true");
|
||||
additionalProperties.put("httpx", "true");
|
||||
} else {
|
||||
supportingFiles.add(new SupportingFile("rest.mustache", packagePath(), "rest.py"));
|
||||
}
|
||||
|
||||
@ -28,10 +28,10 @@ To be able to use it, you will need these dependencies in your own package that
|
||||
|
||||
* urllib3 >= 2.1.0, < 3.0.0
|
||||
* python-dateutil >= 2.8.2
|
||||
{{#asyncio}}
|
||||
{{#async}}
|
||||
* aiohttp >= 3.8.4
|
||||
* aiohttp-retry >= 2.8.3
|
||||
{{/asyncio}}
|
||||
{{/async}}
|
||||
{{#tornado}}
|
||||
* tornado >= 4.2, < 5
|
||||
{{/tornado}}
|
||||
|
||||
@ -32,14 +32,14 @@ class {{classname}}:
|
||||
|
||||
|
||||
@validate_call
|
||||
{{#asyncio}}async {{/asyncio}}def {{operationId}}{{>partial_api_args}} -> {{{returnType}}}{{^returnType}}None{{/returnType}}:
|
||||
{{#async}}async {{/async}}def {{operationId}}{{>partial_api_args}} -> {{{returnType}}}{{^returnType}}None{{/returnType}}:
|
||||
{{>partial_api}}
|
||||
|
||||
response_data = {{#asyncio}}await {{/asyncio}}self.api_client.call_api(
|
||||
response_data = {{#async}}await {{/async}}self.api_client.call_api(
|
||||
*_param,
|
||||
_request_timeout=_request_timeout
|
||||
)
|
||||
{{#asyncio}}await {{/asyncio}}response_data.read()
|
||||
{{#async}}await {{/async}}response_data.read()
|
||||
return self.api_client.response_deserialize(
|
||||
response_data=response_data,
|
||||
response_types_map=_response_types_map,
|
||||
@ -47,14 +47,14 @@ class {{classname}}:
|
||||
|
||||
|
||||
@validate_call
|
||||
{{#asyncio}}async {{/asyncio}}def {{operationId}}_with_http_info{{>partial_api_args}} -> ApiResponse[{{{returnType}}}{{^returnType}}None{{/returnType}}]:
|
||||
{{#async}}async {{/async}}def {{operationId}}_with_http_info{{>partial_api_args}} -> ApiResponse[{{{returnType}}}{{^returnType}}None{{/returnType}}]:
|
||||
{{>partial_api}}
|
||||
|
||||
response_data = {{#asyncio}}await {{/asyncio}}self.api_client.call_api(
|
||||
response_data = {{#async}}await {{/async}}self.api_client.call_api(
|
||||
*_param,
|
||||
_request_timeout=_request_timeout
|
||||
)
|
||||
{{#asyncio}}await {{/asyncio}}response_data.read()
|
||||
{{#async}}await {{/async}}response_data.read()
|
||||
return self.api_client.response_deserialize(
|
||||
response_data=response_data,
|
||||
response_types_map=_response_types_map,
|
||||
@ -62,10 +62,10 @@ class {{classname}}:
|
||||
|
||||
|
||||
@validate_call
|
||||
{{#asyncio}}async {{/asyncio}}def {{operationId}}_without_preload_content{{>partial_api_args}} -> RESTResponseType:
|
||||
{{#async}}async {{/async}}def {{operationId}}_without_preload_content{{>partial_api_args}} -> RESTResponseType:
|
||||
{{>partial_api}}
|
||||
|
||||
response_data = {{#asyncio}}await {{/asyncio}}self.api_client.call_api(
|
||||
response_data = {{#async}}await {{/async}}self.api_client.call_api(
|
||||
*_param,
|
||||
_request_timeout=_request_timeout
|
||||
)
|
||||
|
||||
@ -88,7 +88,7 @@ class ApiClient:
|
||||
self.user_agent = '{{{httpUserAgent}}}{{^httpUserAgent}}OpenAPI-Generator/{{{packageVersion}}}/python{{/httpUserAgent}}'
|
||||
self.client_side_validation = configuration.client_side_validation
|
||||
|
||||
{{#asyncio}}
|
||||
{{#async}}
|
||||
async def __aenter__(self):
|
||||
return self
|
||||
|
||||
@ -97,14 +97,14 @@ class ApiClient:
|
||||
|
||||
async def close(self):
|
||||
await self.rest_client.close()
|
||||
{{/asyncio}}
|
||||
{{^asyncio}}
|
||||
{{/async}}
|
||||
{{^async}}
|
||||
def __enter__(self):
|
||||
return self
|
||||
|
||||
def __exit__(self, exc_type, exc_value, traceback):
|
||||
pass
|
||||
{{/asyncio}}
|
||||
{{/async}}
|
||||
|
||||
@property
|
||||
def user_agent(self):
|
||||
@ -257,7 +257,7 @@ class ApiClient:
|
||||
{{#tornado}}
|
||||
@tornado.gen.coroutine
|
||||
{{/tornado}}
|
||||
{{#asyncio}}async {{/asyncio}}def call_api(
|
||||
{{#async}}async {{/async}}def call_api(
|
||||
self,
|
||||
method,
|
||||
url,
|
||||
@ -280,7 +280,7 @@ class ApiClient:
|
||||
|
||||
try:
|
||||
# perform request and return response
|
||||
response_data = {{#asyncio}}await {{/asyncio}}{{#tornado}}yield {{/tornado}}self.rest_client.request(
|
||||
response_data = {{#async}}await {{/async}}{{#tornado}}yield {{/tornado}}self.rest_client.request(
|
||||
method, url,
|
||||
headers=header_params,
|
||||
body=body, post_params=post_params,
|
||||
|
||||
@ -10,7 +10,7 @@ from pprint import pprint
|
||||
{{> python_doc_auth_partial}}
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
{{#asyncio}}async {{/asyncio}}with {{{packageName}}}.ApiClient(configuration) as api_client:
|
||||
{{#async}}async {{/async}}with {{{packageName}}}.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = {{{packageName}}}.{{{classname}}}(api_client)
|
||||
{{#allParams}}
|
||||
@ -21,7 +21,7 @@ from pprint import pprint
|
||||
{{#summary}}
|
||||
# {{{.}}}
|
||||
{{/summary}}
|
||||
{{#returnType}}api_response = {{/returnType}}{{#asyncio}}await {{/asyncio}}api_instance.{{{operationId}}}({{#allParams}}{{#required}}{{paramName}}{{/required}}{{^required}}{{paramName}}={{paramName}}{{/required}}{{^-last}}, {{/-last}}{{/allParams}})
|
||||
{{#returnType}}api_response = {{/returnType}}{{#async}}await {{/async}}api_instance.{{{operationId}}}({{#allParams}}{{#required}}{{paramName}}{{/required}}{{^required}}{{paramName}}={{paramName}}{{/required}}{{^-last}}, {{/-last}}{{/allParams}})
|
||||
{{#returnType}}
|
||||
print("The response of {{classname}}->{{operationId}}:\n")
|
||||
pprint(api_response)
|
||||
|
||||
@ -8,31 +8,31 @@ import unittest
|
||||
from {{apiPackage}}.{{classFilename}} import {{classname}}
|
||||
|
||||
|
||||
class {{#operations}}Test{{classname}}(unittest.{{#asyncio}}IsolatedAsyncio{{/asyncio}}TestCase):
|
||||
class {{#operations}}Test{{classname}}(unittest.{{#async}}IsolatedAsyncio{{/async}}TestCase):
|
||||
"""{{classname}} unit test stubs"""
|
||||
|
||||
{{#asyncio}}
|
||||
{{#async}}
|
||||
async def asyncSetUp(self) -> None:
|
||||
self.api = {{classname}}()
|
||||
|
||||
async def asyncTearDown(self) -> None:
|
||||
await self.api.api_client.close()
|
||||
{{/asyncio}}
|
||||
{{^asyncio}}
|
||||
{{/async}}
|
||||
{{^async}}
|
||||
def setUp(self) -> None:
|
||||
self.api = {{classname}}()
|
||||
|
||||
def tearDown(self) -> None:
|
||||
pass
|
||||
{{/asyncio}}
|
||||
{{/async}}
|
||||
|
||||
{{#operation}}
|
||||
{{#asyncio}}
|
||||
{{#async}}
|
||||
async def test_{{operationId}}(self) -> None:
|
||||
{{/asyncio}}
|
||||
{{^asyncio}}
|
||||
{{/async}}
|
||||
{{^async}}
|
||||
def test_{{operationId}}(self) -> None:
|
||||
{{/asyncio}}
|
||||
{{/async}}
|
||||
"""Test case for {{{operationId}}}
|
||||
|
||||
{{#summary}}
|
||||
|
||||
@ -8,7 +8,7 @@ from pprint import pprint
|
||||
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
{{#asyncio}}async {{/asyncio}}with {{{packageName}}}.ApiClient(configuration) as api_client:
|
||||
{{#async}}async {{/async}}with {{{packageName}}}.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = {{{packageName}}}.{{{classname}}}(api_client)
|
||||
{{#allParams}}
|
||||
@ -19,7 +19,7 @@ from pprint import pprint
|
||||
{{#summary}}
|
||||
# {{{.}}}
|
||||
{{/summary}}
|
||||
{{#returnType}}api_response = {{/returnType}}{{#asyncio}}await {{/asyncio}}api_instance.{{{operationId}}}({{#allParams}}{{#required}}{{paramName}}{{/required}}{{^required}}{{paramName}}={{paramName}}{{/required}}{{^-last}}, {{/-last}}{{/allParams}})
|
||||
{{#returnType}}api_response = {{/returnType}}{{#async}}await {{/async}}api_instance.{{{operationId}}}({{#allParams}}{{#required}}{{paramName}}{{/required}}{{^required}}{{paramName}}={{paramName}}{{/required}}{{^-last}}, {{/-last}}{{/allParams}})
|
||||
{{#returnType}}
|
||||
print("The response of {{classname}}->{{operationId}}:\n")
|
||||
pprint(api_response)
|
||||
|
||||
@ -7,9 +7,9 @@ import copy
|
||||
import http.client as httplib
|
||||
import logging
|
||||
from logging import FileHandler
|
||||
{{^asyncio}}
|
||||
{{^async}}
|
||||
import multiprocessing
|
||||
{{/asyncio}}
|
||||
{{/async}}
|
||||
import sys
|
||||
from typing import Any, ClassVar, Dict, List, Literal, Optional, TypedDict, Union
|
||||
from typing_extensions import NotRequired, Self
|
||||
@ -395,13 +395,13 @@ conf = {{{packageName}}}.Configuration(
|
||||
Set this to the SNI value expected by the server.
|
||||
"""
|
||||
|
||||
{{#asyncio}}
|
||||
{{#async}}
|
||||
self.connection_pool_maxsize = 100
|
||||
"""This value is passed to the aiohttp to limit simultaneous connections.
|
||||
Default values is 100, None means no-limit.
|
||||
"""
|
||||
{{/asyncio}}
|
||||
{{^asyncio}}
|
||||
{{/async}}
|
||||
{{^async}}
|
||||
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
|
||||
@ -409,7 +409,7 @@ conf = {{{packageName}}}.Configuration(
|
||||
requests to the same host, which is often the case here.
|
||||
cpu_count * 5 is used as default value to increase performance.
|
||||
"""
|
||||
{{/asyncio}}
|
||||
{{/async}}
|
||||
|
||||
self.proxy: Optional[str] = None
|
||||
"""Proxy URL
|
||||
|
||||
185
modules/openapi-generator/src/main/resources/python/httpx/rest.mustache
vendored
Normal file
185
modules/openapi-generator/src/main/resources/python/httpx/rest.mustache
vendored
Normal file
@ -0,0 +1,185 @@
|
||||
# coding: utf-8
|
||||
|
||||
{{>partial_header}}
|
||||
|
||||
|
||||
import io
|
||||
import json
|
||||
import re
|
||||
import ssl
|
||||
from typing import Optional, Union
|
||||
|
||||
import httpx
|
||||
|
||||
from {{packageName}}.exceptions import ApiException, ApiValueError
|
||||
|
||||
RESTResponseType = httpx.Response
|
||||
|
||||
class RESTResponse(io.IOBase):
|
||||
|
||||
def __init__(self, resp) -> None:
|
||||
self.response = resp
|
||||
self.status = resp.status_code
|
||||
self.reason = resp.reason_phrase
|
||||
self.data = None
|
||||
|
||||
async def read(self):
|
||||
if self.data is None:
|
||||
self.data = await self.response.aread()
|
||||
return self.data
|
||||
|
||||
def getheaders(self):
|
||||
"""Returns a CIMultiDictProxy of the response headers."""
|
||||
return self.response.headers
|
||||
|
||||
def getheader(self, name, default=None):
|
||||
"""Returns a given response header."""
|
||||
return self.response.headers.get(name, default)
|
||||
|
||||
|
||||
class RESTClientObject:
|
||||
|
||||
def __init__(self, configuration) -> None:
|
||||
|
||||
# maxsize is number of requests to host that are allowed in parallel
|
||||
self.maxsize = configuration.connection_pool_maxsize
|
||||
|
||||
self.ssl_context = ssl.create_default_context(
|
||||
cafile=configuration.ssl_ca_cert,
|
||||
cadata=configuration.ca_cert_data,
|
||||
)
|
||||
if configuration.cert_file:
|
||||
self.ssl_context.load_cert_chain(
|
||||
configuration.cert_file, keyfile=configuration.key_file
|
||||
)
|
||||
|
||||
if not configuration.verify_ssl:
|
||||
self.ssl_context.check_hostname = False
|
||||
self.ssl_context.verify_mode = ssl.CERT_NONE
|
||||
|
||||
self.proxy = configuration.proxy
|
||||
self.proxy_headers = configuration.proxy_headers
|
||||
|
||||
self.pool_manager: Optional[httpx.AsyncClient] = None
|
||||
|
||||
async def close(self):
|
||||
if self.pool_manager is not None:
|
||||
await self.pool_manager.aclose()
|
||||
|
||||
async def request(
|
||||
self,
|
||||
method,
|
||||
url,
|
||||
headers=None,
|
||||
body=None,
|
||||
post_params=None,
|
||||
_request_timeout=None):
|
||||
"""Execute request
|
||||
|
||||
:param method: http request method
|
||||
:param url: http request url
|
||||
:param headers: http request headers
|
||||
:param body: request json body, for `application/json`
|
||||
:param post_params: request post parameters,
|
||||
`application/x-www-form-urlencoded`
|
||||
and `multipart/form-data`
|
||||
:param _request_timeout: timeout setting for this request. If one
|
||||
number provided, it will be total request
|
||||
timeout. It can also be a pair (tuple) of
|
||||
(connection, read) timeouts.
|
||||
"""
|
||||
method = method.upper()
|
||||
assert method in [
|
||||
'GET',
|
||||
'HEAD',
|
||||
'DELETE',
|
||||
'POST',
|
||||
'PUT',
|
||||
'PATCH',
|
||||
'OPTIONS'
|
||||
]
|
||||
|
||||
if post_params and body:
|
||||
raise ApiValueError(
|
||||
"body parameter cannot be used with post_params parameter."
|
||||
)
|
||||
|
||||
post_params = post_params or {}
|
||||
headers = headers or {}
|
||||
timeout = _request_timeout or 5 * 60
|
||||
|
||||
if 'Content-Type' not in headers:
|
||||
headers['Content-Type'] = 'application/json'
|
||||
|
||||
args = {
|
||||
"method": method,
|
||||
"url": url,
|
||||
"timeout": timeout,
|
||||
"headers": headers
|
||||
}
|
||||
|
||||
# For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE`
|
||||
if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']:
|
||||
if re.search('json', headers['Content-Type'], re.IGNORECASE):
|
||||
if body is not None:
|
||||
args["json"] = body
|
||||
elif headers['Content-Type'] == 'application/x-www-form-urlencoded': # noqa: E501
|
||||
args["data"] = dict(post_params)
|
||||
elif headers['Content-Type'] == 'multipart/form-data':
|
||||
# must del headers['Content-Type'], or the correct
|
||||
# Content-Type which generated by httpx
|
||||
del headers['Content-Type']
|
||||
|
||||
files = []
|
||||
data = {}
|
||||
for param in post_params:
|
||||
k, v = param
|
||||
if isinstance(v, tuple) and len(v) == 3:
|
||||
files.append((k, v))
|
||||
else:
|
||||
# Ensures that dict objects are serialized
|
||||
if isinstance(v, dict):
|
||||
v = json.dumps(v)
|
||||
elif isinstance(v, int):
|
||||
v = str(v)
|
||||
data[k] = v
|
||||
|
||||
if files:
|
||||
args["files"] = files
|
||||
if data:
|
||||
args["data"] = data
|
||||
|
||||
# Pass a `bytes` parameter directly in the body to support
|
||||
# other content types than Json when `body` argument is provided
|
||||
# in serialized form
|
||||
elif isinstance(body, str) or isinstance(body, bytes):
|
||||
args["data"] = body
|
||||
else:
|
||||
# Cannot generate the request from given parameters
|
||||
msg = """Cannot prepare a request message for provided
|
||||
arguments. Please check that your arguments match
|
||||
declared content type."""
|
||||
raise ApiException(status=0, reason=msg)
|
||||
|
||||
if self.pool_manager is None:
|
||||
self.pool_manager = self._create_pool_manager()
|
||||
|
||||
r = await self.pool_manager.request(**args)
|
||||
return RESTResponse(r)
|
||||
|
||||
def _create_pool_manager(self) -> httpx.AsyncClient:
|
||||
limits = httpx.Limits(max_connections=self.maxsize)
|
||||
|
||||
proxy = None
|
||||
if self.proxy:
|
||||
proxy = httpx.Proxy(
|
||||
url=self.proxy,
|
||||
headers=self.proxy_headers
|
||||
)
|
||||
|
||||
return httpx.AsyncClient(
|
||||
limits=limits,
|
||||
proxy=proxy,
|
||||
verify=self.ssl_context,
|
||||
trust_env=True
|
||||
)
|
||||
@ -39,6 +39,9 @@ python-dateutil = ">= 2.8.2"
|
||||
aiohttp = ">= 3.8.4"
|
||||
aiohttp-retry = ">= 2.8.3"
|
||||
{{/asyncio}}
|
||||
{{#httpx}}
|
||||
httpx = ">= 0.28.1"
|
||||
{{/httpx}}
|
||||
{{#tornado}}
|
||||
tornado = ">=4.2, <5"
|
||||
{{/tornado}}
|
||||
@ -58,10 +61,10 @@ requires-python = ">=3.9"
|
||||
dependencies = [
|
||||
"urllib3 (>=2.1.0,<3.0.0)",
|
||||
"python-dateutil (>=2.8.2)",
|
||||
{{#asyncio}}
|
||||
{{#async}}
|
||||
"aiohttp (>=3.8.4)",
|
||||
"aiohttp-retry (>=2.8.3)",
|
||||
{{/asyncio}}
|
||||
{{/async}}
|
||||
{{#tornado}}
|
||||
"tornado (>=4.2,<5)",
|
||||
{{/tornado}}
|
||||
|
||||
@ -4,6 +4,9 @@ python_dateutil >= 2.8.2
|
||||
aiohttp >= 3.8.4
|
||||
aiohttp-retry >= 2.8.3
|
||||
{{/asyncio}}
|
||||
{{#httpx}}
|
||||
httpx = ">= 0.28.1"
|
||||
{{/httpx}}
|
||||
{{#tornado}}
|
||||
tornado = ">= 4.2, < 5"
|
||||
{{/tornado}}
|
||||
|
||||
@ -21,6 +21,9 @@ REQUIRES = [
|
||||
"aiohttp >= 3.8.4",
|
||||
"aiohttp-retry >= 2.8.3",
|
||||
{{/asyncio}}
|
||||
{{#httpx}}
|
||||
"httpx >= 0.28.1",
|
||||
{{/httpx}}
|
||||
{{#tornado}}
|
||||
"tornado>=4.2, < 5",
|
||||
{{/tornado}}
|
||||
|
||||
34
samples/openapi3/client/petstore/python-httpx/.github/workflows/python.yml
vendored
Normal file
34
samples/openapi3/client/petstore/python-httpx/.github/workflows/python.yml
vendored
Normal file
@ -0,0 +1,34 @@
|
||||
# NOTE: This file is auto generated by OpenAPI Generator.
|
||||
# URL: https://openapi-generator.tech
|
||||
#
|
||||
# ref: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
|
||||
|
||||
name: petstore_api Python package
|
||||
|
||||
on: [push, pull_request]
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
jobs:
|
||||
build:
|
||||
|
||||
runs-on: ubuntu-latest
|
||||
strategy:
|
||||
matrix:
|
||||
python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: Set up Python ${{ matrix.python-version }}
|
||||
uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: ${{ matrix.python-version }}
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
python -m pip install --upgrade pip
|
||||
pip install -r requirements.txt
|
||||
pip install -r test-requirements.txt
|
||||
- name: Test with pytest
|
||||
run: |
|
||||
pytest --cov=petstore_api
|
||||
66
samples/openapi3/client/petstore/python-httpx/.gitignore
vendored
Normal file
66
samples/openapi3/client/petstore/python-httpx/.gitignore
vendored
Normal file
@ -0,0 +1,66 @@
|
||||
# Byte-compiled / optimized / DLL files
|
||||
__pycache__/
|
||||
*.py[cod]
|
||||
*$py.class
|
||||
|
||||
# C extensions
|
||||
*.so
|
||||
|
||||
# Distribution / packaging
|
||||
.Python
|
||||
env/
|
||||
build/
|
||||
develop-eggs/
|
||||
dist/
|
||||
downloads/
|
||||
eggs/
|
||||
.eggs/
|
||||
lib/
|
||||
lib64/
|
||||
parts/
|
||||
sdist/
|
||||
var/
|
||||
*.egg-info/
|
||||
.installed.cfg
|
||||
*.egg
|
||||
|
||||
# PyInstaller
|
||||
# Usually these files are written by a python script from a template
|
||||
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
||||
*.manifest
|
||||
*.spec
|
||||
|
||||
# Installer logs
|
||||
pip-log.txt
|
||||
pip-delete-this-directory.txt
|
||||
|
||||
# Unit test / coverage reports
|
||||
htmlcov/
|
||||
.tox/
|
||||
.coverage
|
||||
.coverage.*
|
||||
.cache
|
||||
nosetests.xml
|
||||
coverage.xml
|
||||
*,cover
|
||||
.hypothesis/
|
||||
venv/
|
||||
.venv/
|
||||
.python-version
|
||||
.pytest_cache
|
||||
|
||||
# Translations
|
||||
*.mo
|
||||
*.pot
|
||||
|
||||
# Django stuff:
|
||||
*.log
|
||||
|
||||
# Sphinx documentation
|
||||
docs/_build/
|
||||
|
||||
# PyBuilder
|
||||
target/
|
||||
|
||||
# Ipython Notebook
|
||||
.ipynb_checkpoints
|
||||
31
samples/openapi3/client/petstore/python-httpx/.gitlab-ci.yml
Normal file
31
samples/openapi3/client/petstore/python-httpx/.gitlab-ci.yml
Normal file
@ -0,0 +1,31 @@
|
||||
# NOTE: This file is auto generated by OpenAPI Generator.
|
||||
# URL: https://openapi-generator.tech
|
||||
#
|
||||
# ref: https://docs.gitlab.com/ee/ci/README.html
|
||||
# ref: https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/ci/templates/Python.gitlab-ci.yml
|
||||
|
||||
stages:
|
||||
- test
|
||||
|
||||
.pytest:
|
||||
stage: test
|
||||
script:
|
||||
- pip install -r requirements.txt
|
||||
- pip install -r test-requirements.txt
|
||||
- pytest --cov=petstore_api
|
||||
|
||||
pytest-3.9:
|
||||
extends: .pytest
|
||||
image: python:3.9-alpine
|
||||
pytest-3.10:
|
||||
extends: .pytest
|
||||
image: python:3.10-alpine
|
||||
pytest-3.11:
|
||||
extends: .pytest
|
||||
image: python:3.11-alpine
|
||||
pytest-3.12:
|
||||
extends: .pytest
|
||||
image: python:3.12-alpine
|
||||
pytest-3.13:
|
||||
extends: .pytest
|
||||
image: python:3.13-alpine
|
||||
@ -0,0 +1,23 @@
|
||||
# OpenAPI Generator Ignore
|
||||
# Generated by openapi-generator https://github.com/openapitools/openapi-generator
|
||||
|
||||
# Use this file to prevent files from being overwritten by the generator.
|
||||
# The patterns follow closely to .gitignore or .dockerignore.
|
||||
|
||||
# As an example, the C# client generator defines ApiClient.cs.
|
||||
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
|
||||
#ApiClient.cs
|
||||
|
||||
# You can match any string of characters against a directory, file or extension with a single asterisk (*):
|
||||
#foo/*/qux
|
||||
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
|
||||
|
||||
# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
|
||||
#foo/**/qux
|
||||
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
|
||||
|
||||
# You can also negate patterns with an exclamation (!).
|
||||
# For example, you can ignore all files in a docs folder with the file extension .md:
|
||||
#docs/*.md
|
||||
# Then explicitly reverse the ignore rule for a single file:
|
||||
#!docs/README.md
|
||||
@ -0,0 +1,263 @@
|
||||
.github/workflows/python.yml
|
||||
.gitignore
|
||||
.gitlab-ci.yml
|
||||
.travis.yml
|
||||
README.md
|
||||
docs/AdditionalPropertiesAnyType.md
|
||||
docs/AdditionalPropertiesClass.md
|
||||
docs/AdditionalPropertiesObject.md
|
||||
docs/AdditionalPropertiesWithDescriptionOnly.md
|
||||
docs/AllOfSuperModel.md
|
||||
docs/AllOfWithSingleRef.md
|
||||
docs/Animal.md
|
||||
docs/AnotherFakeApi.md
|
||||
docs/AnyOfColor.md
|
||||
docs/AnyOfPig.md
|
||||
docs/ArrayOfArrayOfModel.md
|
||||
docs/ArrayOfArrayOfNumberOnly.md
|
||||
docs/ArrayOfNumberOnly.md
|
||||
docs/ArrayTest.md
|
||||
docs/BaseDiscriminator.md
|
||||
docs/BasquePig.md
|
||||
docs/Bathing.md
|
||||
docs/Capitalization.md
|
||||
docs/Cat.md
|
||||
docs/Category.md
|
||||
docs/CircularAllOfRef.md
|
||||
docs/CircularReferenceModel.md
|
||||
docs/ClassModel.md
|
||||
docs/Client.md
|
||||
docs/Color.md
|
||||
docs/Creature.md
|
||||
docs/CreatureInfo.md
|
||||
docs/DanishPig.md
|
||||
docs/DataOutputFormat.md
|
||||
docs/DefaultApi.md
|
||||
docs/DeprecatedObject.md
|
||||
docs/DiscriminatorAllOfSub.md
|
||||
docs/DiscriminatorAllOfSuper.md
|
||||
docs/Dog.md
|
||||
docs/DummyModel.md
|
||||
docs/EnumArrays.md
|
||||
docs/EnumClass.md
|
||||
docs/EnumNumberVendorExt.md
|
||||
docs/EnumRefWithDefaultValue.md
|
||||
docs/EnumString1.md
|
||||
docs/EnumString2.md
|
||||
docs/EnumStringVendorExt.md
|
||||
docs/EnumTest.md
|
||||
docs/FakeApi.md
|
||||
docs/FakeClassnameTags123Api.md
|
||||
docs/Feeding.md
|
||||
docs/File.md
|
||||
docs/FileSchemaTestClass.md
|
||||
docs/FirstRef.md
|
||||
docs/Foo.md
|
||||
docs/FooGetDefaultResponse.md
|
||||
docs/FormatTest.md
|
||||
docs/HasOnlyReadOnly.md
|
||||
docs/HealthCheckResult.md
|
||||
docs/HuntingDog.md
|
||||
docs/ImportTestDatetimeApi.md
|
||||
docs/Info.md
|
||||
docs/InnerDictWithProperty.md
|
||||
docs/InputAllOf.md
|
||||
docs/IntOrString.md
|
||||
docs/ListClass.md
|
||||
docs/MapOfArrayOfModel.md
|
||||
docs/MapTest.md
|
||||
docs/MixedPropertiesAndAdditionalPropertiesClass.md
|
||||
docs/Model200Response.md
|
||||
docs/ModelApiResponse.md
|
||||
docs/ModelField.md
|
||||
docs/ModelReturn.md
|
||||
docs/MultiArrays.md
|
||||
docs/Name.md
|
||||
docs/NullableClass.md
|
||||
docs/NullableProperty.md
|
||||
docs/NumberOnly.md
|
||||
docs/ObjectToTestAdditionalProperties.md
|
||||
docs/ObjectWithDeprecatedFields.md
|
||||
docs/OneOfEnumString.md
|
||||
docs/Order.md
|
||||
docs/OuterComposite.md
|
||||
docs/OuterEnum.md
|
||||
docs/OuterEnumDefaultValue.md
|
||||
docs/OuterEnumInteger.md
|
||||
docs/OuterEnumIntegerDefaultValue.md
|
||||
docs/OuterObjectWithEnumProperty.md
|
||||
docs/Parent.md
|
||||
docs/ParentWithOptionalDict.md
|
||||
docs/Pet.md
|
||||
docs/PetApi.md
|
||||
docs/Pig.md
|
||||
docs/PonySizes.md
|
||||
docs/PoopCleaning.md
|
||||
docs/PrimitiveString.md
|
||||
docs/PropertyMap.md
|
||||
docs/PropertyNameCollision.md
|
||||
docs/ReadOnlyFirst.md
|
||||
docs/SecondCircularAllOfRef.md
|
||||
docs/SecondRef.md
|
||||
docs/SelfReferenceModel.md
|
||||
docs/SingleRefType.md
|
||||
docs/SpecialCharacterEnum.md
|
||||
docs/SpecialModelName.md
|
||||
docs/SpecialName.md
|
||||
docs/StoreApi.md
|
||||
docs/Tag.md
|
||||
docs/Task.md
|
||||
docs/TaskActivity.md
|
||||
docs/TestEnum.md
|
||||
docs/TestEnumWithDefault.md
|
||||
docs/TestErrorResponsesWithModel400Response.md
|
||||
docs/TestErrorResponsesWithModel404Response.md
|
||||
docs/TestInlineFreeformAdditionalPropertiesRequest.md
|
||||
docs/TestModelWithEnumDefault.md
|
||||
docs/TestObjectForMultipartRequestsRequestMarker.md
|
||||
docs/Tiger.md
|
||||
docs/Type.md
|
||||
docs/UnnamedDictWithAdditionalModelListProperties.md
|
||||
docs/UnnamedDictWithAdditionalStringListProperties.md
|
||||
docs/UploadFileWithAdditionalPropertiesRequestObject.md
|
||||
docs/User.md
|
||||
docs/UserApi.md
|
||||
docs/WithNestedOneOf.md
|
||||
git_push.sh
|
||||
petstore_api/__init__.py
|
||||
petstore_api/api/__init__.py
|
||||
petstore_api/api/another_fake_api.py
|
||||
petstore_api/api/default_api.py
|
||||
petstore_api/api/fake_api.py
|
||||
petstore_api/api/fake_classname_tags123_api.py
|
||||
petstore_api/api/import_test_datetime_api.py
|
||||
petstore_api/api/pet_api.py
|
||||
petstore_api/api/store_api.py
|
||||
petstore_api/api/user_api.py
|
||||
petstore_api/api_client.py
|
||||
petstore_api/api_response.py
|
||||
petstore_api/configuration.py
|
||||
petstore_api/exceptions.py
|
||||
petstore_api/models/__init__.py
|
||||
petstore_api/models/additional_properties_any_type.py
|
||||
petstore_api/models/additional_properties_class.py
|
||||
petstore_api/models/additional_properties_object.py
|
||||
petstore_api/models/additional_properties_with_description_only.py
|
||||
petstore_api/models/all_of_super_model.py
|
||||
petstore_api/models/all_of_with_single_ref.py
|
||||
petstore_api/models/animal.py
|
||||
petstore_api/models/any_of_color.py
|
||||
petstore_api/models/any_of_pig.py
|
||||
petstore_api/models/array_of_array_of_model.py
|
||||
petstore_api/models/array_of_array_of_number_only.py
|
||||
petstore_api/models/array_of_number_only.py
|
||||
petstore_api/models/array_test.py
|
||||
petstore_api/models/base_discriminator.py
|
||||
petstore_api/models/basque_pig.py
|
||||
petstore_api/models/bathing.py
|
||||
petstore_api/models/capitalization.py
|
||||
petstore_api/models/cat.py
|
||||
petstore_api/models/category.py
|
||||
petstore_api/models/circular_all_of_ref.py
|
||||
petstore_api/models/circular_reference_model.py
|
||||
petstore_api/models/class_model.py
|
||||
petstore_api/models/client.py
|
||||
petstore_api/models/color.py
|
||||
petstore_api/models/creature.py
|
||||
petstore_api/models/creature_info.py
|
||||
petstore_api/models/danish_pig.py
|
||||
petstore_api/models/data_output_format.py
|
||||
petstore_api/models/deprecated_object.py
|
||||
petstore_api/models/discriminator_all_of_sub.py
|
||||
petstore_api/models/discriminator_all_of_super.py
|
||||
petstore_api/models/dog.py
|
||||
petstore_api/models/dummy_model.py
|
||||
petstore_api/models/enum_arrays.py
|
||||
petstore_api/models/enum_class.py
|
||||
petstore_api/models/enum_number_vendor_ext.py
|
||||
petstore_api/models/enum_ref_with_default_value.py
|
||||
petstore_api/models/enum_string1.py
|
||||
petstore_api/models/enum_string2.py
|
||||
petstore_api/models/enum_string_vendor_ext.py
|
||||
petstore_api/models/enum_test.py
|
||||
petstore_api/models/feeding.py
|
||||
petstore_api/models/file.py
|
||||
petstore_api/models/file_schema_test_class.py
|
||||
petstore_api/models/first_ref.py
|
||||
petstore_api/models/foo.py
|
||||
petstore_api/models/foo_get_default_response.py
|
||||
petstore_api/models/format_test.py
|
||||
petstore_api/models/has_only_read_only.py
|
||||
petstore_api/models/health_check_result.py
|
||||
petstore_api/models/hunting_dog.py
|
||||
petstore_api/models/info.py
|
||||
petstore_api/models/inner_dict_with_property.py
|
||||
petstore_api/models/input_all_of.py
|
||||
petstore_api/models/int_or_string.py
|
||||
petstore_api/models/list_class.py
|
||||
petstore_api/models/map_of_array_of_model.py
|
||||
petstore_api/models/map_test.py
|
||||
petstore_api/models/mixed_properties_and_additional_properties_class.py
|
||||
petstore_api/models/model200_response.py
|
||||
petstore_api/models/model_api_response.py
|
||||
petstore_api/models/model_field.py
|
||||
petstore_api/models/model_return.py
|
||||
petstore_api/models/multi_arrays.py
|
||||
petstore_api/models/name.py
|
||||
petstore_api/models/nullable_class.py
|
||||
petstore_api/models/nullable_property.py
|
||||
petstore_api/models/number_only.py
|
||||
petstore_api/models/object_to_test_additional_properties.py
|
||||
petstore_api/models/object_with_deprecated_fields.py
|
||||
petstore_api/models/one_of_enum_string.py
|
||||
petstore_api/models/order.py
|
||||
petstore_api/models/outer_composite.py
|
||||
petstore_api/models/outer_enum.py
|
||||
petstore_api/models/outer_enum_default_value.py
|
||||
petstore_api/models/outer_enum_integer.py
|
||||
petstore_api/models/outer_enum_integer_default_value.py
|
||||
petstore_api/models/outer_object_with_enum_property.py
|
||||
petstore_api/models/parent.py
|
||||
petstore_api/models/parent_with_optional_dict.py
|
||||
petstore_api/models/pet.py
|
||||
petstore_api/models/pig.py
|
||||
petstore_api/models/pony_sizes.py
|
||||
petstore_api/models/poop_cleaning.py
|
||||
petstore_api/models/primitive_string.py
|
||||
petstore_api/models/property_map.py
|
||||
petstore_api/models/property_name_collision.py
|
||||
petstore_api/models/read_only_first.py
|
||||
petstore_api/models/second_circular_all_of_ref.py
|
||||
petstore_api/models/second_ref.py
|
||||
petstore_api/models/self_reference_model.py
|
||||
petstore_api/models/single_ref_type.py
|
||||
petstore_api/models/special_character_enum.py
|
||||
petstore_api/models/special_model_name.py
|
||||
petstore_api/models/special_name.py
|
||||
petstore_api/models/tag.py
|
||||
petstore_api/models/task.py
|
||||
petstore_api/models/task_activity.py
|
||||
petstore_api/models/test_enum.py
|
||||
petstore_api/models/test_enum_with_default.py
|
||||
petstore_api/models/test_error_responses_with_model400_response.py
|
||||
petstore_api/models/test_error_responses_with_model404_response.py
|
||||
petstore_api/models/test_inline_freeform_additional_properties_request.py
|
||||
petstore_api/models/test_model_with_enum_default.py
|
||||
petstore_api/models/test_object_for_multipart_requests_request_marker.py
|
||||
petstore_api/models/tiger.py
|
||||
petstore_api/models/type.py
|
||||
petstore_api/models/unnamed_dict_with_additional_model_list_properties.py
|
||||
petstore_api/models/unnamed_dict_with_additional_string_list_properties.py
|
||||
petstore_api/models/upload_file_with_additional_properties_request_object.py
|
||||
petstore_api/models/user.py
|
||||
petstore_api/models/with_nested_one_of.py
|
||||
petstore_api/py.typed
|
||||
petstore_api/rest.py
|
||||
petstore_api/signing.py
|
||||
pyproject.toml
|
||||
requirements.txt
|
||||
setup.cfg
|
||||
setup.py
|
||||
test-requirements.txt
|
||||
test/__init__.py
|
||||
tox.ini
|
||||
@ -0,0 +1 @@
|
||||
7.16.0-SNAPSHOT
|
||||
17
samples/openapi3/client/petstore/python-httpx/.travis.yml
Normal file
17
samples/openapi3/client/petstore/python-httpx/.travis.yml
Normal file
@ -0,0 +1,17 @@
|
||||
# ref: https://docs.travis-ci.com/user/languages/python
|
||||
language: python
|
||||
python:
|
||||
- "3.9"
|
||||
- "3.10"
|
||||
- "3.11"
|
||||
- "3.12"
|
||||
- "3.13"
|
||||
# uncomment the following if needed
|
||||
#- "3.13-dev" # 3.13 development branch
|
||||
#- "nightly" # nightly build
|
||||
# command to install dependencies
|
||||
install:
|
||||
- "pip install -r requirements.txt"
|
||||
- "pip install -r test-requirements.txt"
|
||||
# command to run tests
|
||||
script: pytest --cov=petstore_api
|
||||
317
samples/openapi3/client/petstore/python-httpx/README.md
Normal file
317
samples/openapi3/client/petstore/python-httpx/README.md
Normal file
@ -0,0 +1,317 @@
|
||||
# petstore-api
|
||||
This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\
|
||||
|
||||
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
||||
|
||||
- API version: 1.0.0
|
||||
- Package version: 1.0.0
|
||||
- Generator version: 7.16.0-SNAPSHOT
|
||||
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
|
||||
|
||||
## Requirements.
|
||||
|
||||
Python 3.9+
|
||||
|
||||
## Installation & Usage
|
||||
### pip install
|
||||
|
||||
If the python package is hosted on a repository, you can install directly using:
|
||||
|
||||
```sh
|
||||
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
|
||||
```
|
||||
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
|
||||
|
||||
Then import the package:
|
||||
```python
|
||||
import petstore_api
|
||||
```
|
||||
|
||||
### Setuptools
|
||||
|
||||
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
|
||||
|
||||
```sh
|
||||
python setup.py install --user
|
||||
```
|
||||
(or `sudo python setup.py install` to install the package for all users)
|
||||
|
||||
Then import the package:
|
||||
```python
|
||||
import petstore_api
|
||||
```
|
||||
|
||||
### Tests
|
||||
|
||||
Execute `pytest` to run the tests.
|
||||
|
||||
## Getting Started
|
||||
|
||||
Please follow the [installation procedure](#installation--usage) and then run the following:
|
||||
|
||||
```python
|
||||
import datetime
|
||||
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(configuration) 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 ApiException as e:
|
||||
print("Exception when calling AnotherFakeApi->call_123_test_special_tags: %s\n" % e)
|
||||
|
||||
```
|
||||
|
||||
## Documentation for API Endpoints
|
||||
|
||||
All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
|
||||
Class | Method | HTTP request | Description
|
||||
------------ | ------------- | ------------- | -------------
|
||||
*AnotherFakeApi* | [**call_123_test_special_tags**](docs/AnotherFakeApi.md#call_123_test_special_tags) | **PATCH** /another-fake/dummy | To test special tags
|
||||
*DefaultApi* | [**foo_get**](docs/DefaultApi.md#foo_get) | **GET** /foo |
|
||||
*FakeApi* | [**fake_any_type_request_body**](docs/FakeApi.md#fake_any_type_request_body) | **POST** /fake/any_type_body | test any type request body
|
||||
*FakeApi* | [**fake_enum_ref_query_parameter**](docs/FakeApi.md#fake_enum_ref_query_parameter) | **GET** /fake/enum_ref_query_parameter | test enum reference query parameter
|
||||
*FakeApi* | [**fake_health_get**](docs/FakeApi.md#fake_health_get) | **GET** /fake/health | Health check endpoint
|
||||
*FakeApi* | [**fake_http_signature_test**](docs/FakeApi.md#fake_http_signature_test) | **GET** /fake/http-signature-test | test http signature authentication
|
||||
*FakeApi* | [**fake_outer_boolean_serialize**](docs/FakeApi.md#fake_outer_boolean_serialize) | **POST** /fake/outer/boolean |
|
||||
*FakeApi* | [**fake_outer_composite_serialize**](docs/FakeApi.md#fake_outer_composite_serialize) | **POST** /fake/outer/composite |
|
||||
*FakeApi* | [**fake_outer_number_serialize**](docs/FakeApi.md#fake_outer_number_serialize) | **POST** /fake/outer/number |
|
||||
*FakeApi* | [**fake_outer_string_serialize**](docs/FakeApi.md#fake_outer_string_serialize) | **POST** /fake/outer/string |
|
||||
*FakeApi* | [**fake_property_enum_integer_serialize**](docs/FakeApi.md#fake_property_enum_integer_serialize) | **POST** /fake/property/enum-int |
|
||||
*FakeApi* | [**fake_ref_enum_string**](docs/FakeApi.md#fake_ref_enum_string) | **GET** /fake/ref_enum_string | test ref to enum string
|
||||
*FakeApi* | [**fake_return_boolean**](docs/FakeApi.md#fake_return_boolean) | **GET** /fake/return_boolean | test returning boolean
|
||||
*FakeApi* | [**fake_return_byte_like_json**](docs/FakeApi.md#fake_return_byte_like_json) | **GET** /fake/return_byte_like_json | test byte like json
|
||||
*FakeApi* | [**fake_return_enum**](docs/FakeApi.md#fake_return_enum) | **GET** /fake/return_enum | test returning enum
|
||||
*FakeApi* | [**fake_return_enum_like_json**](docs/FakeApi.md#fake_return_enum_like_json) | **GET** /fake/return_enum_like_json | test enum like json
|
||||
*FakeApi* | [**fake_return_float**](docs/FakeApi.md#fake_return_float) | **GET** /fake/return_float | test returning float
|
||||
*FakeApi* | [**fake_return_int**](docs/FakeApi.md#fake_return_int) | **GET** /fake/return_int | test returning int
|
||||
*FakeApi* | [**fake_return_list_of_objects**](docs/FakeApi.md#fake_return_list_of_objects) | **GET** /fake/return_list_of_object | test returning list of objects
|
||||
*FakeApi* | [**fake_return_str_like_json**](docs/FakeApi.md#fake_return_str_like_json) | **GET** /fake/return_str_like_json | test str like json
|
||||
*FakeApi* | [**fake_return_string**](docs/FakeApi.md#fake_return_string) | **GET** /fake/return_string | test returning string
|
||||
*FakeApi* | [**fake_uuid_example**](docs/FakeApi.md#fake_uuid_example) | **GET** /fake/uuid_example | test uuid example
|
||||
*FakeApi* | [**test_additional_properties_reference**](docs/FakeApi.md#test_additional_properties_reference) | **POST** /fake/additionalProperties-reference | test referenced additionalProperties
|
||||
*FakeApi* | [**test_body_with_binary**](docs/FakeApi.md#test_body_with_binary) | **PUT** /fake/body-with-binary |
|
||||
*FakeApi* | [**test_body_with_file_schema**](docs/FakeApi.md#test_body_with_file_schema) | **PUT** /fake/body-with-file-schema |
|
||||
*FakeApi* | [**test_body_with_query_params**](docs/FakeApi.md#test_body_with_query_params) | **PUT** /fake/body-with-query-params |
|
||||
*FakeApi* | [**test_client_model**](docs/FakeApi.md#test_client_model) | **PATCH** /fake | To test \"client\" model
|
||||
*FakeApi* | [**test_date_time_query_parameter**](docs/FakeApi.md#test_date_time_query_parameter) | **PUT** /fake/date-time-query-params |
|
||||
*FakeApi* | [**test_empty_and_non_empty_responses**](docs/FakeApi.md#test_empty_and_non_empty_responses) | **POST** /fake/empty_and_non_empty_responses | test empty and non-empty responses
|
||||
*FakeApi* | [**test_endpoint_parameters**](docs/FakeApi.md#test_endpoint_parameters) | **POST** /fake | Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
|
||||
*FakeApi* | [**test_error_responses_with_model**](docs/FakeApi.md#test_error_responses_with_model) | **POST** /fake/error_responses_with_model | test error responses with model
|
||||
*FakeApi* | [**test_group_parameters**](docs/FakeApi.md#test_group_parameters) | **DELETE** /fake | Fake endpoint to test group parameters (optional)
|
||||
*FakeApi* | [**test_inline_additional_properties**](docs/FakeApi.md#test_inline_additional_properties) | **POST** /fake/inline-additionalProperties | test inline additionalProperties
|
||||
*FakeApi* | [**test_inline_freeform_additional_properties**](docs/FakeApi.md#test_inline_freeform_additional_properties) | **POST** /fake/inline-freeform-additionalProperties | test inline free-form additionalProperties
|
||||
*FakeApi* | [**test_json_form_data**](docs/FakeApi.md#test_json_form_data) | **GET** /fake/jsonFormData | test json serialization of form data
|
||||
*FakeApi* | [**test_object_for_multipart_requests**](docs/FakeApi.md#test_object_for_multipart_requests) | **POST** /fake/object_for_multipart_requests |
|
||||
*FakeApi* | [**test_query_parameter_collection_format**](docs/FakeApi.md#test_query_parameter_collection_format) | **PUT** /fake/test-query-parameters |
|
||||
*FakeApi* | [**test_string_map_reference**](docs/FakeApi.md#test_string_map_reference) | **POST** /fake/stringMap-reference | test referenced string map
|
||||
*FakeApi* | [**upload_file_with_additional_properties**](docs/FakeApi.md#upload_file_with_additional_properties) | **POST** /fake/upload_file_with_additional_properties | uploads a file and additional properties using multipart/form-data
|
||||
*FakeClassnameTags123Api* | [**test_classname**](docs/FakeClassnameTags123Api.md#test_classname) | **PATCH** /fake_classname_test | To test class name in snake case
|
||||
*ImportTestDatetimeApi* | [**import_test_return_datetime**](docs/ImportTestDatetimeApi.md#import_test_return_datetime) | **GET** /import_test/return_datetime | test date time
|
||||
*PetApi* | [**add_pet**](docs/PetApi.md#add_pet) | **POST** /pet | Add a new pet to the store
|
||||
*PetApi* | [**delete_pet**](docs/PetApi.md#delete_pet) | **DELETE** /pet/{petId} | Deletes a pet
|
||||
*PetApi* | [**find_pets_by_status**](docs/PetApi.md#find_pets_by_status) | **GET** /pet/findByStatus | Finds Pets by status
|
||||
*PetApi* | [**find_pets_by_tags**](docs/PetApi.md#find_pets_by_tags) | **GET** /pet/findByTags | Finds Pets by tags
|
||||
*PetApi* | [**get_pet_by_id**](docs/PetApi.md#get_pet_by_id) | **GET** /pet/{petId} | Find pet by ID
|
||||
*PetApi* | [**update_pet**](docs/PetApi.md#update_pet) | **PUT** /pet | Update an existing pet
|
||||
*PetApi* | [**update_pet_with_form**](docs/PetApi.md#update_pet_with_form) | **POST** /pet/{petId} | Updates a pet in the store with form data
|
||||
*PetApi* | [**upload_file**](docs/PetApi.md#upload_file) | **POST** /pet/{petId}/uploadImage | uploads an image
|
||||
*PetApi* | [**upload_file_with_required_file**](docs/PetApi.md#upload_file_with_required_file) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required)
|
||||
*StoreApi* | [**delete_order**](docs/StoreApi.md#delete_order) | **DELETE** /store/order/{order_id} | Delete purchase order by ID
|
||||
*StoreApi* | [**get_inventory**](docs/StoreApi.md#get_inventory) | **GET** /store/inventory | Returns pet inventories by status
|
||||
*StoreApi* | [**get_order_by_id**](docs/StoreApi.md#get_order_by_id) | **GET** /store/order/{order_id} | Find purchase order by ID
|
||||
*StoreApi* | [**place_order**](docs/StoreApi.md#place_order) | **POST** /store/order | Place an order for a pet
|
||||
*UserApi* | [**create_user**](docs/UserApi.md#create_user) | **POST** /user | Create user
|
||||
*UserApi* | [**create_users_with_array_input**](docs/UserApi.md#create_users_with_array_input) | **POST** /user/createWithArray | Creates list of users with given input array
|
||||
*UserApi* | [**create_users_with_list_input**](docs/UserApi.md#create_users_with_list_input) | **POST** /user/createWithList | Creates list of users with given input array
|
||||
*UserApi* | [**delete_user**](docs/UserApi.md#delete_user) | **DELETE** /user/{username} | Delete user
|
||||
*UserApi* | [**get_user_by_name**](docs/UserApi.md#get_user_by_name) | **GET** /user/{username} | Get user by user name
|
||||
*UserApi* | [**login_user**](docs/UserApi.md#login_user) | **GET** /user/login | Logs user into the system
|
||||
*UserApi* | [**logout_user**](docs/UserApi.md#logout_user) | **GET** /user/logout | Logs out current logged in user session
|
||||
*UserApi* | [**update_user**](docs/UserApi.md#update_user) | **PUT** /user/{username} | Updated user
|
||||
|
||||
|
||||
## Documentation For Models
|
||||
|
||||
- [AdditionalPropertiesAnyType](docs/AdditionalPropertiesAnyType.md)
|
||||
- [AdditionalPropertiesClass](docs/AdditionalPropertiesClass.md)
|
||||
- [AdditionalPropertiesObject](docs/AdditionalPropertiesObject.md)
|
||||
- [AdditionalPropertiesWithDescriptionOnly](docs/AdditionalPropertiesWithDescriptionOnly.md)
|
||||
- [AllOfSuperModel](docs/AllOfSuperModel.md)
|
||||
- [AllOfWithSingleRef](docs/AllOfWithSingleRef.md)
|
||||
- [Animal](docs/Animal.md)
|
||||
- [AnyOfColor](docs/AnyOfColor.md)
|
||||
- [AnyOfPig](docs/AnyOfPig.md)
|
||||
- [ArrayOfArrayOfModel](docs/ArrayOfArrayOfModel.md)
|
||||
- [ArrayOfArrayOfNumberOnly](docs/ArrayOfArrayOfNumberOnly.md)
|
||||
- [ArrayOfNumberOnly](docs/ArrayOfNumberOnly.md)
|
||||
- [ArrayTest](docs/ArrayTest.md)
|
||||
- [BaseDiscriminator](docs/BaseDiscriminator.md)
|
||||
- [BasquePig](docs/BasquePig.md)
|
||||
- [Bathing](docs/Bathing.md)
|
||||
- [Capitalization](docs/Capitalization.md)
|
||||
- [Cat](docs/Cat.md)
|
||||
- [Category](docs/Category.md)
|
||||
- [CircularAllOfRef](docs/CircularAllOfRef.md)
|
||||
- [CircularReferenceModel](docs/CircularReferenceModel.md)
|
||||
- [ClassModel](docs/ClassModel.md)
|
||||
- [Client](docs/Client.md)
|
||||
- [Color](docs/Color.md)
|
||||
- [Creature](docs/Creature.md)
|
||||
- [CreatureInfo](docs/CreatureInfo.md)
|
||||
- [DanishPig](docs/DanishPig.md)
|
||||
- [DataOutputFormat](docs/DataOutputFormat.md)
|
||||
- [DeprecatedObject](docs/DeprecatedObject.md)
|
||||
- [DiscriminatorAllOfSub](docs/DiscriminatorAllOfSub.md)
|
||||
- [DiscriminatorAllOfSuper](docs/DiscriminatorAllOfSuper.md)
|
||||
- [Dog](docs/Dog.md)
|
||||
- [DummyModel](docs/DummyModel.md)
|
||||
- [EnumArrays](docs/EnumArrays.md)
|
||||
- [EnumClass](docs/EnumClass.md)
|
||||
- [EnumNumberVendorExt](docs/EnumNumberVendorExt.md)
|
||||
- [EnumRefWithDefaultValue](docs/EnumRefWithDefaultValue.md)
|
||||
- [EnumString1](docs/EnumString1.md)
|
||||
- [EnumString2](docs/EnumString2.md)
|
||||
- [EnumStringVendorExt](docs/EnumStringVendorExt.md)
|
||||
- [EnumTest](docs/EnumTest.md)
|
||||
- [Feeding](docs/Feeding.md)
|
||||
- [File](docs/File.md)
|
||||
- [FileSchemaTestClass](docs/FileSchemaTestClass.md)
|
||||
- [FirstRef](docs/FirstRef.md)
|
||||
- [Foo](docs/Foo.md)
|
||||
- [FooGetDefaultResponse](docs/FooGetDefaultResponse.md)
|
||||
- [FormatTest](docs/FormatTest.md)
|
||||
- [HasOnlyReadOnly](docs/HasOnlyReadOnly.md)
|
||||
- [HealthCheckResult](docs/HealthCheckResult.md)
|
||||
- [HuntingDog](docs/HuntingDog.md)
|
||||
- [Info](docs/Info.md)
|
||||
- [InnerDictWithProperty](docs/InnerDictWithProperty.md)
|
||||
- [InputAllOf](docs/InputAllOf.md)
|
||||
- [IntOrString](docs/IntOrString.md)
|
||||
- [ListClass](docs/ListClass.md)
|
||||
- [MapOfArrayOfModel](docs/MapOfArrayOfModel.md)
|
||||
- [MapTest](docs/MapTest.md)
|
||||
- [MixedPropertiesAndAdditionalPropertiesClass](docs/MixedPropertiesAndAdditionalPropertiesClass.md)
|
||||
- [Model200Response](docs/Model200Response.md)
|
||||
- [ModelApiResponse](docs/ModelApiResponse.md)
|
||||
- [ModelField](docs/ModelField.md)
|
||||
- [ModelReturn](docs/ModelReturn.md)
|
||||
- [MultiArrays](docs/MultiArrays.md)
|
||||
- [Name](docs/Name.md)
|
||||
- [NullableClass](docs/NullableClass.md)
|
||||
- [NullableProperty](docs/NullableProperty.md)
|
||||
- [NumberOnly](docs/NumberOnly.md)
|
||||
- [ObjectToTestAdditionalProperties](docs/ObjectToTestAdditionalProperties.md)
|
||||
- [ObjectWithDeprecatedFields](docs/ObjectWithDeprecatedFields.md)
|
||||
- [OneOfEnumString](docs/OneOfEnumString.md)
|
||||
- [Order](docs/Order.md)
|
||||
- [OuterComposite](docs/OuterComposite.md)
|
||||
- [OuterEnum](docs/OuterEnum.md)
|
||||
- [OuterEnumDefaultValue](docs/OuterEnumDefaultValue.md)
|
||||
- [OuterEnumInteger](docs/OuterEnumInteger.md)
|
||||
- [OuterEnumIntegerDefaultValue](docs/OuterEnumIntegerDefaultValue.md)
|
||||
- [OuterObjectWithEnumProperty](docs/OuterObjectWithEnumProperty.md)
|
||||
- [Parent](docs/Parent.md)
|
||||
- [ParentWithOptionalDict](docs/ParentWithOptionalDict.md)
|
||||
- [Pet](docs/Pet.md)
|
||||
- [Pig](docs/Pig.md)
|
||||
- [PonySizes](docs/PonySizes.md)
|
||||
- [PoopCleaning](docs/PoopCleaning.md)
|
||||
- [PrimitiveString](docs/PrimitiveString.md)
|
||||
- [PropertyMap](docs/PropertyMap.md)
|
||||
- [PropertyNameCollision](docs/PropertyNameCollision.md)
|
||||
- [ReadOnlyFirst](docs/ReadOnlyFirst.md)
|
||||
- [SecondCircularAllOfRef](docs/SecondCircularAllOfRef.md)
|
||||
- [SecondRef](docs/SecondRef.md)
|
||||
- [SelfReferenceModel](docs/SelfReferenceModel.md)
|
||||
- [SingleRefType](docs/SingleRefType.md)
|
||||
- [SpecialCharacterEnum](docs/SpecialCharacterEnum.md)
|
||||
- [SpecialModelName](docs/SpecialModelName.md)
|
||||
- [SpecialName](docs/SpecialName.md)
|
||||
- [Tag](docs/Tag.md)
|
||||
- [Task](docs/Task.md)
|
||||
- [TaskActivity](docs/TaskActivity.md)
|
||||
- [TestEnum](docs/TestEnum.md)
|
||||
- [TestEnumWithDefault](docs/TestEnumWithDefault.md)
|
||||
- [TestErrorResponsesWithModel400Response](docs/TestErrorResponsesWithModel400Response.md)
|
||||
- [TestErrorResponsesWithModel404Response](docs/TestErrorResponsesWithModel404Response.md)
|
||||
- [TestInlineFreeformAdditionalPropertiesRequest](docs/TestInlineFreeformAdditionalPropertiesRequest.md)
|
||||
- [TestModelWithEnumDefault](docs/TestModelWithEnumDefault.md)
|
||||
- [TestObjectForMultipartRequestsRequestMarker](docs/TestObjectForMultipartRequestsRequestMarker.md)
|
||||
- [Tiger](docs/Tiger.md)
|
||||
- [Type](docs/Type.md)
|
||||
- [UnnamedDictWithAdditionalModelListProperties](docs/UnnamedDictWithAdditionalModelListProperties.md)
|
||||
- [UnnamedDictWithAdditionalStringListProperties](docs/UnnamedDictWithAdditionalStringListProperties.md)
|
||||
- [UploadFileWithAdditionalPropertiesRequestObject](docs/UploadFileWithAdditionalPropertiesRequestObject.md)
|
||||
- [User](docs/User.md)
|
||||
- [WithNestedOneOf](docs/WithNestedOneOf.md)
|
||||
|
||||
|
||||
<a id="documentation-for-authorization"></a>
|
||||
## Documentation For Authorization
|
||||
|
||||
|
||||
Authentication schemes defined for the API:
|
||||
<a id="petstore_auth"></a>
|
||||
### petstore_auth
|
||||
|
||||
- **Type**: OAuth
|
||||
- **Flow**: implicit
|
||||
- **Authorization URL**: http://petstore.swagger.io/api/oauth/dialog
|
||||
- **Scopes**:
|
||||
- **write:pets**: modify pets in your account
|
||||
- **read:pets**: read your pets
|
||||
|
||||
<a id="api_key"></a>
|
||||
### api_key
|
||||
|
||||
- **Type**: API key
|
||||
- **API key parameter name**: api_key
|
||||
- **Location**: HTTP header
|
||||
|
||||
<a id="api_key_query"></a>
|
||||
### api_key_query
|
||||
|
||||
- **Type**: API key
|
||||
- **API key parameter name**: api_key_query
|
||||
- **Location**: URL query string
|
||||
|
||||
<a id="http_basic_test"></a>
|
||||
### http_basic_test
|
||||
|
||||
- **Type**: HTTP basic authentication
|
||||
|
||||
<a id="bearer_test"></a>
|
||||
### bearer_test
|
||||
|
||||
- **Type**: Bearer authentication (JWT)
|
||||
|
||||
<a id="http_signature_test"></a>
|
||||
### http_signature_test
|
||||
|
||||
- **Type**: HTTP signature authentication
|
||||
|
||||
|
||||
## Author
|
||||
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,29 @@
|
||||
# AdditionalPropertiesAnyType
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **str** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from petstore_api.models.additional_properties_any_type import AdditionalPropertiesAnyType
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AdditionalPropertiesAnyType from a JSON string
|
||||
additional_properties_any_type_instance = AdditionalPropertiesAnyType.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(AdditionalPropertiesAnyType.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
additional_properties_any_type_dict = additional_properties_any_type_instance.to_dict()
|
||||
# create an instance of AdditionalPropertiesAnyType from a dict
|
||||
additional_properties_any_type_from_dict = AdditionalPropertiesAnyType.from_dict(additional_properties_any_type_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)
|
||||
|
||||
|
||||
@ -0,0 +1,30 @@
|
||||
# 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_from_dict = AdditionalPropertiesClass.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)
|
||||
|
||||
|
||||
@ -0,0 +1,29 @@
|
||||
# AdditionalPropertiesObject
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **str** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from petstore_api.models.additional_properties_object import AdditionalPropertiesObject
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AdditionalPropertiesObject from a JSON string
|
||||
additional_properties_object_instance = AdditionalPropertiesObject.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(AdditionalPropertiesObject.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
additional_properties_object_dict = additional_properties_object_instance.to_dict()
|
||||
# create an instance of AdditionalPropertiesObject from a dict
|
||||
additional_properties_object_from_dict = AdditionalPropertiesObject.from_dict(additional_properties_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)
|
||||
|
||||
|
||||
@ -0,0 +1,29 @@
|
||||
# AdditionalPropertiesWithDescriptionOnly
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **str** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from petstore_api.models.additional_properties_with_description_only import AdditionalPropertiesWithDescriptionOnly
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AdditionalPropertiesWithDescriptionOnly from a JSON string
|
||||
additional_properties_with_description_only_instance = AdditionalPropertiesWithDescriptionOnly.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(AdditionalPropertiesWithDescriptionOnly.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
additional_properties_with_description_only_dict = additional_properties_with_description_only_instance.to_dict()
|
||||
# create an instance of AdditionalPropertiesWithDescriptionOnly from a dict
|
||||
additional_properties_with_description_only_from_dict = AdditionalPropertiesWithDescriptionOnly.from_dict(additional_properties_with_description_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)
|
||||
|
||||
|
||||
@ -0,0 +1,29 @@
|
||||
# AllOfSuperModel
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **str** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from petstore_api.models.all_of_super_model import AllOfSuperModel
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AllOfSuperModel from a JSON string
|
||||
all_of_super_model_instance = AllOfSuperModel.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(AllOfSuperModel.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
all_of_super_model_dict = all_of_super_model_instance.to_dict()
|
||||
# create an instance of AllOfSuperModel from a dict
|
||||
all_of_super_model_from_dict = AllOfSuperModel.from_dict(all_of_super_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)
|
||||
|
||||
|
||||
@ -0,0 +1,30 @@
|
||||
# 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_from_dict = AllOfWithSingleRef.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)
|
||||
|
||||
|
||||
30
samples/openapi3/client/petstore/python-httpx/docs/Animal.md
Normal file
30
samples/openapi3/client/petstore/python-httpx/docs/Animal.md
Normal file
@ -0,0 +1,30 @@
|
||||
# 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_from_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)
|
||||
|
||||
|
||||
@ -0,0 +1,77 @@
|
||||
# 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
|
||||
import petstore_api
|
||||
from petstore_api.models.client import Client
|
||||
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(configuration) 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)
|
||||
|
||||
@ -0,0 +1,29 @@
|
||||
# AnyOfColor
|
||||
|
||||
Any of RGB array, RGBA array, or hex string.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from petstore_api.models.any_of_color import AnyOfColor
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AnyOfColor from a JSON string
|
||||
any_of_color_instance = AnyOfColor.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(AnyOfColor.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
any_of_color_dict = any_of_color_instance.to_dict()
|
||||
# create an instance of AnyOfColor from a dict
|
||||
any_of_color_from_dict = AnyOfColor.from_dict(any_of_color_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)
|
||||
|
||||
|
||||
@ -0,0 +1,31 @@
|
||||
# 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_from_dict = AnyOfPig.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)
|
||||
|
||||
|
||||
@ -0,0 +1,29 @@
|
||||
# ArrayOfArrayOfModel
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**another_property** | **List[List[Tag]]** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from petstore_api.models.array_of_array_of_model import ArrayOfArrayOfModel
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ArrayOfArrayOfModel from a JSON string
|
||||
array_of_array_of_model_instance = ArrayOfArrayOfModel.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(ArrayOfArrayOfModel.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
array_of_array_of_model_dict = array_of_array_of_model_instance.to_dict()
|
||||
# create an instance of ArrayOfArrayOfModel from a dict
|
||||
array_of_array_of_model_from_dict = ArrayOfArrayOfModel.from_dict(array_of_array_of_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)
|
||||
|
||||
|
||||
@ -0,0 +1,29 @@
|
||||
# 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_from_dict = ArrayOfArrayOfNumberOnly.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)
|
||||
|
||||
|
||||
@ -0,0 +1,29 @@
|
||||
# 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_from_dict = ArrayOfNumberOnly.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)
|
||||
|
||||
|
||||
@ -0,0 +1,32 @@
|
||||
# ArrayTest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**array_of_string** | **List[str]** | | [optional]
|
||||
**array_of_nullable_float** | **List[Optional[float]]** | | [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_from_dict = ArrayTest.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)
|
||||
|
||||
|
||||
@ -0,0 +1,29 @@
|
||||
# BaseDiscriminator
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**type_name** | **str** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from petstore_api.models.base_discriminator import BaseDiscriminator
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of BaseDiscriminator from a JSON string
|
||||
base_discriminator_instance = BaseDiscriminator.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(BaseDiscriminator.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
base_discriminator_dict = base_discriminator_instance.to_dict()
|
||||
# create an instance of BaseDiscriminator from a dict
|
||||
base_discriminator_from_dict = BaseDiscriminator.from_dict(base_discriminator_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)
|
||||
|
||||
|
||||
@ -0,0 +1,30 @@
|
||||
# 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_from_dict = BasquePig.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)
|
||||
|
||||
|
||||
@ -0,0 +1,31 @@
|
||||
# Bathing
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**task_name** | **str** | |
|
||||
**function_name** | **str** | |
|
||||
**content** | **str** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from petstore_api.models.bathing import Bathing
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of Bathing from a JSON string
|
||||
bathing_instance = Bathing.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(Bathing.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
bathing_dict = bathing_instance.to_dict()
|
||||
# create an instance of Bathing from a dict
|
||||
bathing_from_dict = Bathing.from_dict(bathing_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)
|
||||
|
||||
|
||||
@ -0,0 +1,34 @@
|
||||
# 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_from_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)
|
||||
|
||||
|
||||
29
samples/openapi3/client/petstore/python-httpx/docs/Cat.md
Normal file
29
samples/openapi3/client/petstore/python-httpx/docs/Cat.md
Normal file
@ -0,0 +1,29 @@
|
||||
# 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_from_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)
|
||||
|
||||
|
||||
@ -0,0 +1,30 @@
|
||||
# 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_from_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)
|
||||
|
||||
|
||||
@ -0,0 +1,30 @@
|
||||
# CircularAllOfRef
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **str** | | [optional]
|
||||
**second_circular_all_of_ref** | [**List[SecondCircularAllOfRef]**](SecondCircularAllOfRef.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from petstore_api.models.circular_all_of_ref import CircularAllOfRef
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of CircularAllOfRef from a JSON string
|
||||
circular_all_of_ref_instance = CircularAllOfRef.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(CircularAllOfRef.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
circular_all_of_ref_dict = circular_all_of_ref_instance.to_dict()
|
||||
# create an instance of CircularAllOfRef from a dict
|
||||
circular_all_of_ref_from_dict = CircularAllOfRef.from_dict(circular_all_of_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)
|
||||
|
||||
|
||||
@ -0,0 +1,30 @@
|
||||
# CircularReferenceModel
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**size** | **int** | | [optional]
|
||||
**nested** | [**FirstRef**](FirstRef.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from petstore_api.models.circular_reference_model import CircularReferenceModel
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of CircularReferenceModel from a JSON string
|
||||
circular_reference_model_instance = CircularReferenceModel.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(CircularReferenceModel.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
circular_reference_model_dict = circular_reference_model_instance.to_dict()
|
||||
# create an instance of CircularReferenceModel from a dict
|
||||
circular_reference_model_from_dict = CircularReferenceModel.from_dict(circular_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)
|
||||
|
||||
|
||||
@ -0,0 +1,30 @@
|
||||
# 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_from_dict = ClassModel.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)
|
||||
|
||||
|
||||
29
samples/openapi3/client/petstore/python-httpx/docs/Client.md
Normal file
29
samples/openapi3/client/petstore/python-httpx/docs/Client.md
Normal file
@ -0,0 +1,29 @@
|
||||
# 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_from_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-httpx/docs/Color.md
Normal file
29
samples/openapi3/client/petstore/python-httpx/docs/Color.md
Normal file
@ -0,0 +1,29 @@
|
||||
# Color
|
||||
|
||||
RGB array, RGBA array, or hex string.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from petstore_api.models.color import Color
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of Color from a JSON string
|
||||
color_instance = Color.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(Color.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
color_dict = color_instance.to_dict()
|
||||
# create an instance of Color from a dict
|
||||
color_from_dict = Color.from_dict(color_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)
|
||||
|
||||
|
||||
@ -0,0 +1,30 @@
|
||||
# Creature
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**info** | [**CreatureInfo**](CreatureInfo.md) | |
|
||||
**type** | **str** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from petstore_api.models.creature import Creature
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of Creature from a JSON string
|
||||
creature_instance = Creature.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(Creature.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
creature_dict = creature_instance.to_dict()
|
||||
# create an instance of Creature from a dict
|
||||
creature_from_dict = Creature.from_dict(creature_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)
|
||||
|
||||
|
||||
@ -0,0 +1,29 @@
|
||||
# CreatureInfo
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **str** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from petstore_api.models.creature_info import CreatureInfo
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of CreatureInfo from a JSON string
|
||||
creature_info_instance = CreatureInfo.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(CreatureInfo.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
creature_info_dict = creature_info_instance.to_dict()
|
||||
# create an instance of CreatureInfo from a dict
|
||||
creature_info_from_dict = CreatureInfo.from_dict(creature_info_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)
|
||||
|
||||
|
||||
@ -0,0 +1,30 @@
|
||||
# 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_from_dict = DanishPig.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)
|
||||
|
||||
|
||||
@ -0,0 +1,14 @@
|
||||
# DataOutputFormat
|
||||
|
||||
|
||||
## Enum
|
||||
|
||||
* `JSON` (value: `'JSON'`)
|
||||
|
||||
* `CSV` (value: `'CSV'`)
|
||||
|
||||
* `XML` (value: `'XML'`)
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@ -0,0 +1,68 @@
|
||||
# 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
|
||||
import petstore_api
|
||||
from petstore_api.models.foo_get_default_response import FooGetDefaultResponse
|
||||
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(configuration) 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)
|
||||
|
||||
@ -0,0 +1,29 @@
|
||||
# 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_from_dict = DeprecatedObject.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)
|
||||
|
||||
|
||||
@ -0,0 +1,28 @@
|
||||
# DiscriminatorAllOfSub
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from petstore_api.models.discriminator_all_of_sub import DiscriminatorAllOfSub
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of DiscriminatorAllOfSub from a JSON string
|
||||
discriminator_all_of_sub_instance = DiscriminatorAllOfSub.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(DiscriminatorAllOfSub.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
discriminator_all_of_sub_dict = discriminator_all_of_sub_instance.to_dict()
|
||||
# create an instance of DiscriminatorAllOfSub from a dict
|
||||
discriminator_all_of_sub_from_dict = DiscriminatorAllOfSub.from_dict(discriminator_all_of_sub_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)
|
||||
|
||||
|
||||
@ -0,0 +1,29 @@
|
||||
# DiscriminatorAllOfSuper
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**element_type** | **str** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from petstore_api.models.discriminator_all_of_super import DiscriminatorAllOfSuper
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of DiscriminatorAllOfSuper from a JSON string
|
||||
discriminator_all_of_super_instance = DiscriminatorAllOfSuper.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(DiscriminatorAllOfSuper.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
discriminator_all_of_super_dict = discriminator_all_of_super_instance.to_dict()
|
||||
# create an instance of DiscriminatorAllOfSuper from a dict
|
||||
discriminator_all_of_super_from_dict = DiscriminatorAllOfSuper.from_dict(discriminator_all_of_super_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-httpx/docs/Dog.md
Normal file
29
samples/openapi3/client/petstore/python-httpx/docs/Dog.md
Normal file
@ -0,0 +1,29 @@
|
||||
# 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_from_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)
|
||||
|
||||
|
||||
@ -0,0 +1,30 @@
|
||||
# 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_from_dict = DummyModel.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)
|
||||
|
||||
|
||||
@ -0,0 +1,30 @@
|
||||
# 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_from_dict = EnumArrays.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)
|
||||
|
||||
|
||||
@ -0,0 +1,14 @@
|
||||
# EnumClass
|
||||
|
||||
|
||||
## Enum
|
||||
|
||||
* `ABC` (value: `'_abc'`)
|
||||
|
||||
* `MINUS_EFG` (value: `'-efg'`)
|
||||
|
||||
* `LEFT_PARENTHESIS_XYZ_RIGHT_PARENTHESIS` (value: `'(xyz)'`)
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@ -0,0 +1,14 @@
|
||||
# EnumNumberVendorExt
|
||||
|
||||
|
||||
## Enum
|
||||
|
||||
* `FortyTwo` (value: `42`)
|
||||
|
||||
* `Eigtheen` (value: `18`)
|
||||
|
||||
* `FiftySix` (value: `56`)
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@ -0,0 +1,29 @@
|
||||
# EnumRefWithDefaultValue
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**report_format** | [**DataOutputFormat**](DataOutputFormat.md) | | [optional] [default to DataOutputFormat.JSON]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from petstore_api.models.enum_ref_with_default_value import EnumRefWithDefaultValue
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of EnumRefWithDefaultValue from a JSON string
|
||||
enum_ref_with_default_value_instance = EnumRefWithDefaultValue.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(EnumRefWithDefaultValue.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
enum_ref_with_default_value_dict = enum_ref_with_default_value_instance.to_dict()
|
||||
# create an instance of EnumRefWithDefaultValue from a dict
|
||||
enum_ref_with_default_value_from_dict = EnumRefWithDefaultValue.from_dict(enum_ref_with_default_value_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)
|
||||
|
||||
|
||||
@ -0,0 +1,12 @@
|
||||
# EnumString1
|
||||
|
||||
|
||||
## Enum
|
||||
|
||||
* `A` (value: `'a'`)
|
||||
|
||||
* `B` (value: `'b'`)
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@ -0,0 +1,12 @@
|
||||
# EnumString2
|
||||
|
||||
|
||||
## Enum
|
||||
|
||||
* `C` (value: `'c'`)
|
||||
|
||||
* `D` (value: `'d'`)
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@ -0,0 +1,14 @@
|
||||
# EnumStringVendorExt
|
||||
|
||||
|
||||
## Enum
|
||||
|
||||
* `FOO_XEnumVarname` (value: `'FOO'`)
|
||||
|
||||
* `BarVar_XEnumVarname` (value: `'Bar'`)
|
||||
|
||||
* `bazVar_XEnumVarname` (value: `'baz'`)
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
@ -0,0 +1,41 @@
|
||||
# EnumTest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**enum_string** | **str** | | [optional]
|
||||
**enum_string_required** | **str** | |
|
||||
**enum_integer_default** | **int** | | [optional] [default to 5]
|
||||
**enum_integer** | **int** | | [optional]
|
||||
**enum_number** | **float** | | [optional]
|
||||
**enum_string_single_member** | **str** | | [optional]
|
||||
**enum_integer_single_member** | **int** | | [optional]
|
||||
**outer_enum** | [**OuterEnum**](OuterEnum.md) | | [optional]
|
||||
**outer_enum_integer** | [**OuterEnumInteger**](OuterEnumInteger.md) | | [optional]
|
||||
**outer_enum_default_value** | [**OuterEnumDefaultValue**](OuterEnumDefaultValue.md) | | [optional] [default to OuterEnumDefaultValue.PLACED]
|
||||
**outer_enum_integer_default_value** | [**OuterEnumIntegerDefaultValue**](OuterEnumIntegerDefaultValue.md) | | [optional] [default to OuterEnumIntegerDefaultValue.NUMBER_0]
|
||||
**enum_number_vendor_ext** | [**EnumNumberVendorExt**](EnumNumberVendorExt.md) | | [optional]
|
||||
**enum_string_vendor_ext** | [**EnumStringVendorExt**](EnumStringVendorExt.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_from_dict = EnumTest.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)
|
||||
|
||||
|
||||
2540
samples/openapi3/client/petstore/python-httpx/docs/FakeApi.md
Normal file
2540
samples/openapi3/client/petstore/python-httpx/docs/FakeApi.md
Normal file
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,88 @@
|
||||
# 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
|
||||
import petstore_api
|
||||
from petstore_api.models.client import Client
|
||||
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)
|
||||
|
||||
@ -0,0 +1,31 @@
|
||||
# Feeding
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**task_name** | **str** | |
|
||||
**function_name** | **str** | |
|
||||
**content** | **str** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from petstore_api.models.feeding import Feeding
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of Feeding from a JSON string
|
||||
feeding_instance = Feeding.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(Feeding.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
feeding_dict = feeding_instance.to_dict()
|
||||
# create an instance of Feeding from a dict
|
||||
feeding_from_dict = Feeding.from_dict(feeding_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-httpx/docs/File.md
Normal file
30
samples/openapi3/client/petstore/python-httpx/docs/File.md
Normal file
@ -0,0 +1,30 @@
|
||||
# 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_from_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)
|
||||
|
||||
|
||||
@ -0,0 +1,30 @@
|
||||
# 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_from_dict = FileSchemaTestClass.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)
|
||||
|
||||
|
||||
@ -0,0 +1,30 @@
|
||||
# FirstRef
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**category** | **str** | | [optional]
|
||||
**self_ref** | [**SecondRef**](SecondRef.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from petstore_api.models.first_ref import FirstRef
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of FirstRef from a JSON string
|
||||
first_ref_instance = FirstRef.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(FirstRef.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
first_ref_dict = first_ref_instance.to_dict()
|
||||
# create an instance of FirstRef from a dict
|
||||
first_ref_from_dict = FirstRef.from_dict(first_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-httpx/docs/Foo.md
Normal file
29
samples/openapi3/client/petstore/python-httpx/docs/Foo.md
Normal file
@ -0,0 +1,29 @@
|
||||
# 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_from_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)
|
||||
|
||||
|
||||
@ -0,0 +1,29 @@
|
||||
# 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_from_dict = FooGetDefaultResponse.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)
|
||||
|
||||
|
||||
@ -0,0 +1,45 @@
|
||||
# FormatTest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**integer** | **int** | | [optional]
|
||||
**int32** | **int** | | [optional]
|
||||
**int64** | **int** | | [optional]
|
||||
**number** | **float** | |
|
||||
**var_float** | **float** | | [optional]
|
||||
**double** | **float** | | [optional]
|
||||
**decimal** | **decimal.Decimal** | | [optional]
|
||||
**string** | **str** | | [optional]
|
||||
**string_with_double_quote_pattern** | **str** | | [optional]
|
||||
**byte** | **bytearray** | | [optional]
|
||||
**binary** | **bytearray** | | [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_from_dict = FormatTest.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)
|
||||
|
||||
|
||||
@ -0,0 +1,30 @@
|
||||
# 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_from_dict = HasOnlyReadOnly.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)
|
||||
|
||||
|
||||
@ -0,0 +1,30 @@
|
||||
# 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_from_dict = HealthCheckResult.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)
|
||||
|
||||
|
||||
@ -0,0 +1,29 @@
|
||||
# HuntingDog
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**is_trained** | **bool** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from petstore_api.models.hunting_dog import HuntingDog
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of HuntingDog from a JSON string
|
||||
hunting_dog_instance = HuntingDog.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(HuntingDog.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
hunting_dog_dict = hunting_dog_instance.to_dict()
|
||||
# create an instance of HuntingDog from a dict
|
||||
hunting_dog_from_dict = HuntingDog.from_dict(hunting_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)
|
||||
|
||||
|
||||
@ -0,0 +1,70 @@
|
||||
# petstore_api.ImportTestDatetimeApi
|
||||
|
||||
All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**import_test_return_datetime**](ImportTestDatetimeApi.md#import_test_return_datetime) | **GET** /import_test/return_datetime | test date time
|
||||
|
||||
|
||||
# **import_test_return_datetime**
|
||||
> datetime import_test_return_datetime()
|
||||
|
||||
test date time
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
```python
|
||||
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(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = petstore_api.ImportTestDatetimeApi(api_client)
|
||||
|
||||
try:
|
||||
# test date time
|
||||
api_response = await api_instance.import_test_return_datetime()
|
||||
print("The response of ImportTestDatetimeApi->import_test_return_datetime:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling ImportTestDatetimeApi->import_test_return_datetime: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
**datetime**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### HTTP response details
|
||||
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
**200** | OK | - |
|
||||
|
||||
[[Back to top]](#) [[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-httpx/docs/Info.md
Normal file
29
samples/openapi3/client/petstore/python-httpx/docs/Info.md
Normal file
@ -0,0 +1,29 @@
|
||||
# Info
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**val** | [**BaseDiscriminator**](BaseDiscriminator.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from petstore_api.models.info import Info
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of Info from a JSON string
|
||||
info_instance = Info.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(Info.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
info_dict = info_instance.to_dict()
|
||||
# create an instance of Info from a dict
|
||||
info_from_dict = Info.from_dict(info_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)
|
||||
|
||||
|
||||
@ -0,0 +1,29 @@
|
||||
# InnerDictWithProperty
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**a_property** | **object** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from petstore_api.models.inner_dict_with_property import InnerDictWithProperty
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of InnerDictWithProperty from a JSON string
|
||||
inner_dict_with_property_instance = InnerDictWithProperty.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(InnerDictWithProperty.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
inner_dict_with_property_dict = inner_dict_with_property_instance.to_dict()
|
||||
# create an instance of InnerDictWithProperty from a dict
|
||||
inner_dict_with_property_from_dict = InnerDictWithProperty.from_dict(inner_dict_with_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)
|
||||
|
||||
|
||||
@ -0,0 +1,29 @@
|
||||
# InputAllOf
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**some_data** | [**Dict[str, Tag]**](Tag.md) | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from petstore_api.models.input_all_of import InputAllOf
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of InputAllOf from a JSON string
|
||||
input_all_of_instance = InputAllOf.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(InputAllOf.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
input_all_of_dict = input_all_of_instance.to_dict()
|
||||
# create an instance of InputAllOf from a dict
|
||||
input_all_of_from_dict = InputAllOf.from_dict(input_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)
|
||||
|
||||
|
||||
@ -0,0 +1,28 @@
|
||||
# IntOrString
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from petstore_api.models.int_or_string import IntOrString
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of IntOrString from a JSON string
|
||||
int_or_string_instance = IntOrString.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(IntOrString.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
int_or_string_dict = int_or_string_instance.to_dict()
|
||||
# create an instance of IntOrString from a dict
|
||||
int_or_string_from_dict = IntOrString.from_dict(int_or_string_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)
|
||||
|
||||
|
||||
@ -0,0 +1,29 @@
|
||||
# ListClass
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**var_123_list** | **str** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from petstore_api.models.list_class import ListClass
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ListClass from a JSON string
|
||||
list_class_instance = ListClass.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(ListClass.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
list_class_dict = list_class_instance.to_dict()
|
||||
# create an instance of ListClass from a dict
|
||||
list_class_from_dict = ListClass.from_dict(list_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)
|
||||
|
||||
|
||||
@ -0,0 +1,29 @@
|
||||
# MapOfArrayOfModel
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**shop_id_to_org_online_lip_map** | **Dict[str, List[Tag]]** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from petstore_api.models.map_of_array_of_model import MapOfArrayOfModel
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of MapOfArrayOfModel from a JSON string
|
||||
map_of_array_of_model_instance = MapOfArrayOfModel.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(MapOfArrayOfModel.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
map_of_array_of_model_dict = map_of_array_of_model_instance.to_dict()
|
||||
# create an instance of MapOfArrayOfModel from a dict
|
||||
map_of_array_of_model_from_dict = MapOfArrayOfModel.from_dict(map_of_array_of_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)
|
||||
|
||||
|
||||
@ -0,0 +1,32 @@
|
||||
# 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_from_dict = MapTest.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)
|
||||
|
||||
|
||||
@ -0,0 +1,31 @@
|
||||
# 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_from_dict = MixedPropertiesAndAdditionalPropertiesClass.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)
|
||||
|
||||
|
||||
@ -0,0 +1,31 @@
|
||||
# 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_from_dict = Model200Response.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)
|
||||
|
||||
|
||||
@ -0,0 +1,31 @@
|
||||
# ModelApiResponse
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**code** | **int** | | [optional]
|
||||
**type** | **str** | | [optional]
|
||||
**message** | **str** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from petstore_api.models.model_api_response import ModelApiResponse
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ModelApiResponse from a JSON string
|
||||
model_api_response_instance = ModelApiResponse.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(ModelApiResponse.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
model_api_response_dict = model_api_response_instance.to_dict()
|
||||
# create an instance of ModelApiResponse from a dict
|
||||
model_api_response_from_dict = ModelApiResponse.from_dict(model_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)
|
||||
|
||||
|
||||
@ -0,0 +1,29 @@
|
||||
# ModelField
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**var_field** | **str** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from petstore_api.models.model_field import ModelField
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ModelField from a JSON string
|
||||
model_field_instance = ModelField.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(ModelField.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
model_field_dict = model_field_instance.to_dict()
|
||||
# create an instance of ModelField from a dict
|
||||
model_field_from_dict = ModelField.from_dict(model_field_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)
|
||||
|
||||
|
||||
@ -0,0 +1,30 @@
|
||||
# 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_from_dict = ModelReturn.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)
|
||||
|
||||
|
||||
@ -0,0 +1,30 @@
|
||||
# MultiArrays
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**tags** | [**List[Tag]**](Tag.md) | | [optional]
|
||||
**files** | [**List[File]**](File.md) | Another array of objects in addition to tags (mypy check to not to reuse the same iterator) | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from petstore_api.models.multi_arrays import MultiArrays
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of MultiArrays from a JSON string
|
||||
multi_arrays_instance = MultiArrays.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(MultiArrays.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
multi_arrays_dict = multi_arrays_instance.to_dict()
|
||||
# create an instance of MultiArrays from a dict
|
||||
multi_arrays_from_dict = MultiArrays.from_dict(multi_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)
|
||||
|
||||
|
||||
33
samples/openapi3/client/petstore/python-httpx/docs/Name.md
Normal file
33
samples/openapi3/client/petstore/python-httpx/docs/Name.md
Normal file
@ -0,0 +1,33 @@
|
||||
# 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_from_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)
|
||||
|
||||
|
||||
@ -0,0 +1,41 @@
|
||||
# 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[Optional[object]]** | | [optional]
|
||||
**array_items_nullable** | **List[Optional[object]]** | | [optional]
|
||||
**object_nullable_prop** | **Dict[str, object]** | | [optional]
|
||||
**object_and_items_nullable_prop** | **Dict[str, Optional[object]]** | | [optional]
|
||||
**object_items_nullable** | **Dict[str, Optional[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_from_dict = NullableClass.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)
|
||||
|
||||
|
||||
@ -0,0 +1,30 @@
|
||||
# NullableProperty
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **int** | |
|
||||
**name** | **str** | |
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from petstore_api.models.nullable_property import NullableProperty
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of NullableProperty from a JSON string
|
||||
nullable_property_instance = NullableProperty.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(NullableProperty.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
nullable_property_dict = nullable_property_instance.to_dict()
|
||||
# create an instance of NullableProperty from a dict
|
||||
nullable_property_from_dict = NullableProperty.from_dict(nullable_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)
|
||||
|
||||
|
||||
@ -0,0 +1,29 @@
|
||||
# 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_from_dict = NumberOnly.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)
|
||||
|
||||
|
||||
@ -0,0 +1,30 @@
|
||||
# ObjectToTestAdditionalProperties
|
||||
|
||||
Minimal object
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**var_property** | **bool** | Property | [optional] [default to False]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from petstore_api.models.object_to_test_additional_properties import ObjectToTestAdditionalProperties
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ObjectToTestAdditionalProperties from a JSON string
|
||||
object_to_test_additional_properties_instance = ObjectToTestAdditionalProperties.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print(ObjectToTestAdditionalProperties.to_json())
|
||||
|
||||
# convert the object into a dict
|
||||
object_to_test_additional_properties_dict = object_to_test_additional_properties_instance.to_dict()
|
||||
# create an instance of ObjectToTestAdditionalProperties from a dict
|
||||
object_to_test_additional_properties_from_dict = ObjectToTestAdditionalProperties.from_dict(object_to_test_additional_properties_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)
|
||||
|
||||
|
||||
@ -0,0 +1,32 @@
|
||||
# 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_from_dict = ObjectWithDeprecatedFields.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)
|
||||
|
||||
|
||||
@ -0,0 +1,17 @@
|
||||
# OneOfEnumString
|
||||
|
||||
oneOf enum strings
|
||||
|
||||
## Enum
|
||||
|
||||
* `A` (value: `'a'`)
|
||||
|
||||
* `B` (value: `'b'`)
|
||||
|
||||
* `C` (value: `'c'`)
|
||||
|
||||
* `D` (value: `'d'`)
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
34
samples/openapi3/client/petstore/python-httpx/docs/Order.md
Normal file
34
samples/openapi3/client/petstore/python-httpx/docs/Order.md
Normal file
@ -0,0 +1,34 @@
|
||||
# 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_from_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)
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user