python: feature flag for lazy imports (#21885)

* python: feature flag for lazy imports

* python: update samples

* python: add python-lazyImports to test job

* python: reuse tests in lazyImports sample

* python: avoid using non-imported submodules

* add normalizer option

---------

Co-authored-by: Pascal Bachor <bachorp@users.noreply.github.com>
Co-authored-by: William Cheng <wing328hk@gmail.com>
This commit is contained in:
Pascal Bachor 2025-09-10 11:22:41 +02:00 committed by GitHub
parent 0e42edc95b
commit 6825d9ccaa
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
440 changed files with 50287 additions and 818 deletions

View File

@ -35,6 +35,7 @@ jobs:
sample:
- samples/openapi3/client/petstore/python-aiohttp
- samples/openapi3/client/petstore/python
- samples/openapi3/client/petstore/python-lazyImports
services:
petstore-api:
image: swaggerapi/petstore

View File

@ -0,0 +1,18 @@
generatorName: python
outputDir: samples/openapi3/client/petstore/python-lazyImports
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
additionalProperties:
packageName: petstore_api
useOneOfDiscriminatorLookup: "true"
disallowAdditionalPropertiesIfNotPresent: false
mapNumberTo: StrictFloat
lazyImports: 'true'
nameMappings:
_type: underscore_type
type_: type_with_underscore
modelNameMappings:
# The OpenAPI spec ApiResponse conflicts with the internal ApiResponse
ApiResponse: ModelApiResponse
openapiNormalizer:
SIMPLIFY_ONEOF_ANYOF_ENUM: false

View File

@ -24,6 +24,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
|disallowAdditionalPropertiesIfNotPresent|If false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.|<dl><dt>**false**</dt><dd>The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.</dd><dt>**true**</dt><dd>Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.</dd></dl>|true|
|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|
|mapNumberTo|Map number to Union[StrictFloat, StrictInt], StrictStr or float.| |Union[StrictFloat, StrictInt]|
|packageName|python package name (convention: snake_case).| |openapi_client|

View File

@ -48,6 +48,7 @@ public class PythonClientCodegen extends AbstractPythonCodegen implements Codege
public static final String DATE_FORMAT = "dateFormat";
public static final String SET_ENSURE_ASCII_TO_FALSE = "setEnsureAsciiToFalse";
public static final String POETRY1_FALLBACK = "poetry1";
public static final String LAZY_IMPORTS = "lazyImports";
@Setter protected String packageUrl;
protected String apiDocPath = "docs/";
@ -151,6 +152,7 @@ public class PythonClientCodegen extends AbstractPythonCodegen implements Codege
.defaultValue("%Y-%m-%d"));
cliOptions.add(new CliOption(CodegenConstants.USE_ONEOF_DISCRIMINATOR_LOOKUP, CodegenConstants.USE_ONEOF_DISCRIMINATOR_LOOKUP_DESC).defaultValue("false"));
cliOptions.add(new CliOption(POETRY1_FALLBACK, "Fallback to formatting pyproject.toml to Poetry 1.x format."));
cliOptions.add(new CliOption(LAZY_IMPORTS, "Enable lazy imports.").defaultValue(Boolean.FALSE.toString()));
supportedLibraries.put("urllib3", "urllib3-based client");
supportedLibraries.put("asyncio", "asyncio-based client");
@ -264,6 +266,10 @@ public class PythonClientCodegen extends AbstractPythonCodegen implements Codege
additionalProperties.put(DATE_FORMAT, dateFormat);
}
if (additionalProperties.containsKey(LAZY_IMPORTS)) {
additionalProperties.put(LAZY_IMPORTS, Boolean.valueOf(additionalProperties.get(LAZY_IMPORTS).toString()));
}
String modelPath = packagePath() + File.separatorChar + modelPackage.replace('.', File.separatorChar);
String apiPath = packagePath() + File.separatorChar + apiPackage.replace('.', File.separatorChar);

View File

@ -1,6 +1,9 @@
# flake8: noqa
if __import__("typing").TYPE_CHECKING:
{{^lazyImports}}
{{>exports_api}}
{{/lazyImports}}
{{#lazyImports}}if __import__("typing").TYPE_CHECKING:
{{>exports_api}}
else:
from lazy_imports import LazyModule, as_package, load
@ -13,3 +16,4 @@ else:
doc=__doc__,
)
)
{{/lazyImports}}

View File

@ -3,8 +3,10 @@
# flake8: noqa
{{>partial_header}}
if __import__("typing").TYPE_CHECKING:
{{^lazyImports}}
{{>exports_model}}
{{/lazyImports}}
{{#lazyImports}}if __import__("typing").TYPE_CHECKING:
{{>exports_model}}
else:
from lazy_imports import LazyModule, as_package, load
@ -17,3 +19,4 @@ else:
doc=__doc__,
)
)
{{/lazyImports}}

View File

@ -24,7 +24,10 @@ __all__ = [
{{/-last}}{{#-last}},{{/-last}}{{/model}}{{/models}}
]
if __import__("typing").TYPE_CHECKING:
{{^lazyImports}}
{{>exports_package}}
{{/lazyImports}}
{{#lazyImports}}if __import__("typing").TYPE_CHECKING:
{{>exports_package}}
else:
from lazy_imports import LazyModule, as_package, load
@ -39,6 +42,7 @@ else:
doc=__doc__,
)
)
{{/lazyImports}}
{{#recursionLimit}}
__import__('sys').setrecursionlimit({{{.}}})

View File

@ -48,7 +48,9 @@ pycryptodome = ">= 3.9.0"
{{/hasHttpSignatureMethods}}
pydantic = ">= 2"
typing-extensions = ">= 4.7.1"
{{#lazyImports}}
lazy-imports = ">= 1, < 2"
{{/lazyImports}}
{{/poetry1}}
{{^poetry1}}
requires-python = ">=3.9"
@ -69,7 +71,9 @@ dependencies = [
{{/hasHttpSignatureMethods}}
"pydantic (>=2)",
"typing-extensions (>=4.7.1)",
{{#lazyImports}}
"lazy-imports (>=1,<2)"
{{/lazyImports}}
]
[project.urls]

View File

@ -13,4 +13,6 @@ pycryptodome >= 3.9.0
{{/hasHttpSignatureMethods}}
pydantic >= 2
typing-extensions >= 4.7.1
{{#lazyImports}}
lazy-imports >= 1, < 2
{{/lazyImports}}

View File

@ -30,7 +30,9 @@ REQUIRES = [
{{/hasHttpSignatureMethods}}
"pydantic >= 2",
"typing-extensions >= 4.7.1",
{{#lazyImports}}
"lazy-imports >= 1, < 2",
{{/lazyImports}}
]
setup(

View File

@ -48,49 +48,7 @@ __all__ = [
"TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter",
]
if __import__("typing").TYPE_CHECKING:
# import apis into sdk package
from openapi_client.api.auth_api import AuthApi as AuthApi
from openapi_client.api.body_api import BodyApi as BodyApi
from openapi_client.api.form_api import FormApi as FormApi
from openapi_client.api.header_api import HeaderApi as HeaderApi
from openapi_client.api.path_api import PathApi as PathApi
from openapi_client.api.query_api import QueryApi as QueryApi
# import ApiClient
from openapi_client.api_response import ApiResponse as ApiResponse
from openapi_client.api_client import ApiClient as ApiClient
from openapi_client.configuration import Configuration as Configuration
from openapi_client.exceptions import OpenApiException as OpenApiException
from openapi_client.exceptions import ApiTypeError as ApiTypeError
from openapi_client.exceptions import ApiValueError as ApiValueError
from openapi_client.exceptions import ApiKeyError as ApiKeyError
from openapi_client.exceptions import ApiAttributeError as ApiAttributeError
from openapi_client.exceptions import ApiException as ApiException
# import models into sdk package
from openapi_client.models.bird import Bird as Bird
from openapi_client.models.category import Category as Category
from openapi_client.models.data_query import DataQuery as DataQuery
from openapi_client.models.default_value import DefaultValue as DefaultValue
from openapi_client.models.number_properties_only import NumberPropertiesOnly as NumberPropertiesOnly
from openapi_client.models.pet import Pet as Pet
from openapi_client.models.query import Query as Query
from openapi_client.models.string_enum_ref import StringEnumRef as StringEnumRef
from openapi_client.models.tag import Tag as Tag
from openapi_client.models.test_form_object_multipart_request_marker import TestFormObjectMultipartRequestMarker as TestFormObjectMultipartRequestMarker
from openapi_client.models.test_query_style_deep_object_explode_true_object_all_of_query_object_parameter import TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter as TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter
from openapi_client.models.test_query_style_form_explode_true_array_string_query_object_parameter import TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter as TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter
else:
from lazy_imports import LazyModule, as_package, load
load(
LazyModule(
*as_package(__file__),
("__version__", __version__),
("__all__", __all__),
"""# import apis into sdk package
# import apis into sdk package
from openapi_client.api.auth_api import AuthApi as AuthApi
from openapi_client.api.body_api import BodyApi as BodyApi
from openapi_client.api.form_api import FormApi as FormApi
@ -123,8 +81,3 @@ from openapi_client.models.test_form_object_multipart_request_marker import Test
from openapi_client.models.test_query_style_deep_object_explode_true_object_all_of_query_object_parameter import TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter as TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter
from openapi_client.models.test_query_style_form_explode_true_array_string_query_object_parameter import TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter as TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter
""",
name=__name__,
doc=__doc__,
)
)

View File

@ -1,21 +1,6 @@
# flake8: noqa
if __import__("typing").TYPE_CHECKING:
# import apis into api package
from openapi_client.api.auth_api import AuthApi
from openapi_client.api.body_api import BodyApi
from openapi_client.api.form_api import FormApi
from openapi_client.api.header_api import HeaderApi
from openapi_client.api.path_api import PathApi
from openapi_client.api.query_api import QueryApi
else:
from lazy_imports import LazyModule, as_package, load
load(
LazyModule(
*as_package(__file__),
"""# import apis into api package
# import apis into api package
from openapi_client.api.auth_api import AuthApi
from openapi_client.api.body_api import BodyApi
from openapi_client.api.form_api import FormApi
@ -23,8 +8,3 @@ from openapi_client.api.header_api import HeaderApi
from openapi_client.api.path_api import PathApi
from openapi_client.api.query_api import QueryApi
""",
name=__name__,
doc=__doc__,
)
)

View File

@ -13,29 +13,7 @@
Do not edit the class manually.
""" # noqa: E501
if __import__("typing").TYPE_CHECKING:
# import models into model package
from openapi_client.models.bird import Bird
from openapi_client.models.category import Category
from openapi_client.models.data_query import DataQuery
from openapi_client.models.default_value import DefaultValue
from openapi_client.models.number_properties_only import NumberPropertiesOnly
from openapi_client.models.pet import Pet
from openapi_client.models.query import Query
from openapi_client.models.string_enum_ref import StringEnumRef
from openapi_client.models.tag import Tag
from openapi_client.models.test_form_object_multipart_request_marker import TestFormObjectMultipartRequestMarker
from openapi_client.models.test_query_style_deep_object_explode_true_object_all_of_query_object_parameter import TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter
from openapi_client.models.test_query_style_form_explode_true_array_string_query_object_parameter import TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter
else:
from lazy_imports import LazyModule, as_package, load
load(
LazyModule(
*as_package(__file__),
"""# import models into model package
# import models into model package
from openapi_client.models.bird import Bird
from openapi_client.models.category import Category
from openapi_client.models.data_query import DataQuery
@ -49,8 +27,3 @@ from openapi_client.models.test_form_object_multipart_request_marker import Test
from openapi_client.models.test_query_style_deep_object_explode_true_object_all_of_query_object_parameter import TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter
from openapi_client.models.test_query_style_form_explode_true_array_string_query_object_parameter import TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter
""",
name=__name__,
doc=__doc__,
)
)

View File

@ -15,7 +15,6 @@ dependencies = [
"python-dateutil (>=2.8.2)",
"pydantic (>=2)",
"typing-extensions (>=4.7.1)",
"lazy-imports (>=1,<2)"
]
[project.urls]

View File

@ -2,4 +2,3 @@ urllib3 >= 2.1.0, < 3.0.0
python_dateutil >= 2.8.2
pydantic >= 2
typing-extensions >= 4.7.1
lazy-imports >= 1, < 2

View File

@ -29,7 +29,6 @@ REQUIRES = [
"python-dateutil >= 2.8.2",
"pydantic >= 2",
"typing-extensions >= 4.7.1",
"lazy-imports >= 1, < 2",
]
setup(

View File

@ -48,49 +48,7 @@ __all__ = [
"TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter",
]
if __import__("typing").TYPE_CHECKING:
# import apis into sdk package
from openapi_client.api.auth_api import AuthApi as AuthApi
from openapi_client.api.body_api import BodyApi as BodyApi
from openapi_client.api.form_api import FormApi as FormApi
from openapi_client.api.header_api import HeaderApi as HeaderApi
from openapi_client.api.path_api import PathApi as PathApi
from openapi_client.api.query_api import QueryApi as QueryApi
# import ApiClient
from openapi_client.api_response import ApiResponse as ApiResponse
from openapi_client.api_client import ApiClient as ApiClient
from openapi_client.configuration import Configuration as Configuration
from openapi_client.exceptions import OpenApiException as OpenApiException
from openapi_client.exceptions import ApiTypeError as ApiTypeError
from openapi_client.exceptions import ApiValueError as ApiValueError
from openapi_client.exceptions import ApiKeyError as ApiKeyError
from openapi_client.exceptions import ApiAttributeError as ApiAttributeError
from openapi_client.exceptions import ApiException as ApiException
# import models into sdk package
from openapi_client.models.bird import Bird as Bird
from openapi_client.models.category import Category as Category
from openapi_client.models.data_query import DataQuery as DataQuery
from openapi_client.models.default_value import DefaultValue as DefaultValue
from openapi_client.models.number_properties_only import NumberPropertiesOnly as NumberPropertiesOnly
from openapi_client.models.pet import Pet as Pet
from openapi_client.models.query import Query as Query
from openapi_client.models.string_enum_ref import StringEnumRef as StringEnumRef
from openapi_client.models.tag import Tag as Tag
from openapi_client.models.test_form_object_multipart_request_marker import TestFormObjectMultipartRequestMarker as TestFormObjectMultipartRequestMarker
from openapi_client.models.test_query_style_deep_object_explode_true_object_all_of_query_object_parameter import TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter as TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter
from openapi_client.models.test_query_style_form_explode_true_array_string_query_object_parameter import TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter as TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter
else:
from lazy_imports import LazyModule, as_package, load
load(
LazyModule(
*as_package(__file__),
("__version__", __version__),
("__all__", __all__),
"""# import apis into sdk package
# import apis into sdk package
from openapi_client.api.auth_api import AuthApi as AuthApi
from openapi_client.api.body_api import BodyApi as BodyApi
from openapi_client.api.form_api import FormApi as FormApi
@ -123,8 +81,3 @@ from openapi_client.models.test_form_object_multipart_request_marker import Test
from openapi_client.models.test_query_style_deep_object_explode_true_object_all_of_query_object_parameter import TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter as TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter
from openapi_client.models.test_query_style_form_explode_true_array_string_query_object_parameter import TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter as TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter
""",
name=__name__,
doc=__doc__,
)
)

View File

@ -1,21 +1,6 @@
# flake8: noqa
if __import__("typing").TYPE_CHECKING:
# import apis into api package
from openapi_client.api.auth_api import AuthApi
from openapi_client.api.body_api import BodyApi
from openapi_client.api.form_api import FormApi
from openapi_client.api.header_api import HeaderApi
from openapi_client.api.path_api import PathApi
from openapi_client.api.query_api import QueryApi
else:
from lazy_imports import LazyModule, as_package, load
load(
LazyModule(
*as_package(__file__),
"""# import apis into api package
# import apis into api package
from openapi_client.api.auth_api import AuthApi
from openapi_client.api.body_api import BodyApi
from openapi_client.api.form_api import FormApi
@ -23,8 +8,3 @@ from openapi_client.api.header_api import HeaderApi
from openapi_client.api.path_api import PathApi
from openapi_client.api.query_api import QueryApi
""",
name=__name__,
doc=__doc__,
)
)

View File

@ -13,29 +13,7 @@
Do not edit the class manually.
""" # noqa: E501
if __import__("typing").TYPE_CHECKING:
# import models into model package
from openapi_client.models.bird import Bird
from openapi_client.models.category import Category
from openapi_client.models.data_query import DataQuery
from openapi_client.models.default_value import DefaultValue
from openapi_client.models.number_properties_only import NumberPropertiesOnly
from openapi_client.models.pet import Pet
from openapi_client.models.query import Query
from openapi_client.models.string_enum_ref import StringEnumRef
from openapi_client.models.tag import Tag
from openapi_client.models.test_form_object_multipart_request_marker import TestFormObjectMultipartRequestMarker
from openapi_client.models.test_query_style_deep_object_explode_true_object_all_of_query_object_parameter import TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter
from openapi_client.models.test_query_style_form_explode_true_array_string_query_object_parameter import TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter
else:
from lazy_imports import LazyModule, as_package, load
load(
LazyModule(
*as_package(__file__),
"""# import models into model package
# import models into model package
from openapi_client.models.bird import Bird
from openapi_client.models.category import Category
from openapi_client.models.data_query import DataQuery
@ -49,8 +27,3 @@ from openapi_client.models.test_form_object_multipart_request_marker import Test
from openapi_client.models.test_query_style_deep_object_explode_true_object_all_of_query_object_parameter import TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter
from openapi_client.models.test_query_style_form_explode_true_array_string_query_object_parameter import TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter
""",
name=__name__,
doc=__doc__,
)
)

View File

@ -15,7 +15,6 @@ dependencies = [
"python-dateutil (>=2.8.2)",
"pydantic (>=2)",
"typing-extensions (>=4.7.1)",
"lazy-imports (>=1,<2)"
]
[project.urls]

View File

@ -2,4 +2,3 @@ urllib3 >= 2.1.0, < 3.0.0
python_dateutil >= 2.8.2
pydantic >= 2
typing-extensions >= 4.7.1
lazy-imports >= 1, < 2

View File

@ -29,7 +29,6 @@ REQUIRES = [
"python-dateutil >= 2.8.2",
"pydantic >= 2",
"typing-extensions >= 4.7.1",
"lazy-imports >= 1, < 2",
]
setup(

View File

@ -150,152 +150,7 @@ __all__ = [
"WithNestedOneOf",
]
if __import__("typing").TYPE_CHECKING:
# import apis into sdk package
from petstore_api.api.another_fake_api import AnotherFakeApi as AnotherFakeApi
from petstore_api.api.default_api import DefaultApi as DefaultApi
from petstore_api.api.fake_api import FakeApi as FakeApi
from petstore_api.api.fake_classname_tags123_api import FakeClassnameTags123Api as FakeClassnameTags123Api
from petstore_api.api.import_test_datetime_api import ImportTestDatetimeApi as ImportTestDatetimeApi
from petstore_api.api.pet_api import PetApi as PetApi
from petstore_api.api.store_api import StoreApi as StoreApi
from petstore_api.api.user_api import UserApi as UserApi
# import ApiClient
from petstore_api.api_response import ApiResponse as ApiResponse
from petstore_api.api_client import ApiClient as ApiClient
from petstore_api.configuration import Configuration as Configuration
from petstore_api.exceptions import OpenApiException as OpenApiException
from petstore_api.exceptions import ApiTypeError as ApiTypeError
from petstore_api.exceptions import ApiValueError as ApiValueError
from petstore_api.exceptions import ApiKeyError as ApiKeyError
from petstore_api.exceptions import ApiAttributeError as ApiAttributeError
from petstore_api.exceptions import ApiException as ApiException
from petstore_api.signing import HttpSigningConfiguration as HttpSigningConfiguration
# import models into sdk package
from petstore_api.models.additional_properties_any_type import AdditionalPropertiesAnyType as AdditionalPropertiesAnyType
from petstore_api.models.additional_properties_class import AdditionalPropertiesClass as AdditionalPropertiesClass
from petstore_api.models.additional_properties_object import AdditionalPropertiesObject as AdditionalPropertiesObject
from petstore_api.models.additional_properties_with_description_only import AdditionalPropertiesWithDescriptionOnly as AdditionalPropertiesWithDescriptionOnly
from petstore_api.models.all_of_super_model import AllOfSuperModel as AllOfSuperModel
from petstore_api.models.all_of_with_single_ref import AllOfWithSingleRef as AllOfWithSingleRef
from petstore_api.models.animal import Animal as Animal
from petstore_api.models.any_of_color import AnyOfColor as AnyOfColor
from petstore_api.models.any_of_pig import AnyOfPig as AnyOfPig
from petstore_api.models.array_of_array_of_model import ArrayOfArrayOfModel as ArrayOfArrayOfModel
from petstore_api.models.array_of_array_of_number_only import ArrayOfArrayOfNumberOnly as ArrayOfArrayOfNumberOnly
from petstore_api.models.array_of_number_only import ArrayOfNumberOnly as ArrayOfNumberOnly
from petstore_api.models.array_test import ArrayTest as ArrayTest
from petstore_api.models.base_discriminator import BaseDiscriminator as BaseDiscriminator
from petstore_api.models.basque_pig import BasquePig as BasquePig
from petstore_api.models.bathing import Bathing as Bathing
from petstore_api.models.capitalization import Capitalization as Capitalization
from petstore_api.models.cat import Cat as Cat
from petstore_api.models.category import Category as Category
from petstore_api.models.circular_all_of_ref import CircularAllOfRef as CircularAllOfRef
from petstore_api.models.circular_reference_model import CircularReferenceModel as CircularReferenceModel
from petstore_api.models.class_model import ClassModel as ClassModel
from petstore_api.models.client import Client as Client
from petstore_api.models.color import Color as Color
from petstore_api.models.creature import Creature as Creature
from petstore_api.models.creature_info import CreatureInfo as CreatureInfo
from petstore_api.models.danish_pig import DanishPig as DanishPig
from petstore_api.models.data_output_format import DataOutputFormat as DataOutputFormat
from petstore_api.models.deprecated_object import DeprecatedObject as DeprecatedObject
from petstore_api.models.discriminator_all_of_sub import DiscriminatorAllOfSub as DiscriminatorAllOfSub
from petstore_api.models.discriminator_all_of_super import DiscriminatorAllOfSuper as DiscriminatorAllOfSuper
from petstore_api.models.dog import Dog as Dog
from petstore_api.models.dummy_model import DummyModel as DummyModel
from petstore_api.models.enum_arrays import EnumArrays as EnumArrays
from petstore_api.models.enum_class import EnumClass as EnumClass
from petstore_api.models.enum_number_vendor_ext import EnumNumberVendorExt as EnumNumberVendorExt
from petstore_api.models.enum_ref_with_default_value import EnumRefWithDefaultValue as EnumRefWithDefaultValue
from petstore_api.models.enum_string1 import EnumString1 as EnumString1
from petstore_api.models.enum_string2 import EnumString2 as EnumString2
from petstore_api.models.enum_string_vendor_ext import EnumStringVendorExt as EnumStringVendorExt
from petstore_api.models.enum_test import EnumTest as EnumTest
from petstore_api.models.feeding import Feeding as Feeding
from petstore_api.models.file import File as File
from petstore_api.models.file_schema_test_class import FileSchemaTestClass as FileSchemaTestClass
from petstore_api.models.first_ref import FirstRef as FirstRef
from petstore_api.models.foo import Foo as Foo
from petstore_api.models.foo_get_default_response import FooGetDefaultResponse as FooGetDefaultResponse
from petstore_api.models.format_test import FormatTest as FormatTest
from petstore_api.models.has_only_read_only import HasOnlyReadOnly as HasOnlyReadOnly
from petstore_api.models.health_check_result import HealthCheckResult as HealthCheckResult
from petstore_api.models.hunting_dog import HuntingDog as HuntingDog
from petstore_api.models.info import Info as Info
from petstore_api.models.inner_dict_with_property import InnerDictWithProperty as InnerDictWithProperty
from petstore_api.models.input_all_of import InputAllOf as InputAllOf
from petstore_api.models.int_or_string import IntOrString as IntOrString
from petstore_api.models.list_class import ListClass as ListClass
from petstore_api.models.map_of_array_of_model import MapOfArrayOfModel as MapOfArrayOfModel
from petstore_api.models.map_test import MapTest as MapTest
from petstore_api.models.mixed_properties_and_additional_properties_class import MixedPropertiesAndAdditionalPropertiesClass as MixedPropertiesAndAdditionalPropertiesClass
from petstore_api.models.model200_response import Model200Response as Model200Response
from petstore_api.models.model_api_response import ModelApiResponse as ModelApiResponse
from petstore_api.models.model_field import ModelField as ModelField
from petstore_api.models.model_return import ModelReturn as ModelReturn
from petstore_api.models.multi_arrays import MultiArrays as MultiArrays
from petstore_api.models.name import Name as Name
from petstore_api.models.nullable_class import NullableClass as NullableClass
from petstore_api.models.nullable_property import NullableProperty as NullableProperty
from petstore_api.models.number_only import NumberOnly as NumberOnly
from petstore_api.models.object_to_test_additional_properties import ObjectToTestAdditionalProperties as ObjectToTestAdditionalProperties
from petstore_api.models.object_with_deprecated_fields import ObjectWithDeprecatedFields as ObjectWithDeprecatedFields
from petstore_api.models.one_of_enum_string import OneOfEnumString as OneOfEnumString
from petstore_api.models.order import Order as Order
from petstore_api.models.outer_composite import OuterComposite as OuterComposite
from petstore_api.models.outer_enum import OuterEnum as OuterEnum
from petstore_api.models.outer_enum_default_value import OuterEnumDefaultValue as OuterEnumDefaultValue
from petstore_api.models.outer_enum_integer import OuterEnumInteger as OuterEnumInteger
from petstore_api.models.outer_enum_integer_default_value import OuterEnumIntegerDefaultValue as OuterEnumIntegerDefaultValue
from petstore_api.models.outer_object_with_enum_property import OuterObjectWithEnumProperty as OuterObjectWithEnumProperty
from petstore_api.models.parent import Parent as Parent
from petstore_api.models.parent_with_optional_dict import ParentWithOptionalDict as ParentWithOptionalDict
from petstore_api.models.pet import Pet as Pet
from petstore_api.models.pig import Pig as Pig
from petstore_api.models.pony_sizes import PonySizes as PonySizes
from petstore_api.models.poop_cleaning import PoopCleaning as PoopCleaning
from petstore_api.models.primitive_string import PrimitiveString as PrimitiveString
from petstore_api.models.property_map import PropertyMap as PropertyMap
from petstore_api.models.property_name_collision import PropertyNameCollision as PropertyNameCollision
from petstore_api.models.read_only_first import ReadOnlyFirst as ReadOnlyFirst
from petstore_api.models.second_circular_all_of_ref import SecondCircularAllOfRef as SecondCircularAllOfRef
from petstore_api.models.second_ref import SecondRef as SecondRef
from petstore_api.models.self_reference_model import SelfReferenceModel as SelfReferenceModel
from petstore_api.models.single_ref_type import SingleRefType as SingleRefType
from petstore_api.models.special_character_enum import SpecialCharacterEnum as SpecialCharacterEnum
from petstore_api.models.special_model_name import SpecialModelName as SpecialModelName
from petstore_api.models.special_name import SpecialName as SpecialName
from petstore_api.models.tag import Tag as Tag
from petstore_api.models.task import Task as Task
from petstore_api.models.task_activity import TaskActivity as TaskActivity
from petstore_api.models.test_enum import TestEnum as TestEnum
from petstore_api.models.test_enum_with_default import TestEnumWithDefault as TestEnumWithDefault
from petstore_api.models.test_error_responses_with_model400_response import TestErrorResponsesWithModel400Response as TestErrorResponsesWithModel400Response
from petstore_api.models.test_error_responses_with_model404_response import TestErrorResponsesWithModel404Response as TestErrorResponsesWithModel404Response
from petstore_api.models.test_inline_freeform_additional_properties_request import TestInlineFreeformAdditionalPropertiesRequest as TestInlineFreeformAdditionalPropertiesRequest
from petstore_api.models.test_model_with_enum_default import TestModelWithEnumDefault as TestModelWithEnumDefault
from petstore_api.models.test_object_for_multipart_requests_request_marker import TestObjectForMultipartRequestsRequestMarker as TestObjectForMultipartRequestsRequestMarker
from petstore_api.models.tiger import Tiger as Tiger
from petstore_api.models.type import Type as Type
from petstore_api.models.unnamed_dict_with_additional_model_list_properties import UnnamedDictWithAdditionalModelListProperties as UnnamedDictWithAdditionalModelListProperties
from petstore_api.models.unnamed_dict_with_additional_string_list_properties import UnnamedDictWithAdditionalStringListProperties as UnnamedDictWithAdditionalStringListProperties
from petstore_api.models.upload_file_with_additional_properties_request_object import UploadFileWithAdditionalPropertiesRequestObject as UploadFileWithAdditionalPropertiesRequestObject
from petstore_api.models.user import User as User
from petstore_api.models.with_nested_one_of import WithNestedOneOf as WithNestedOneOf
else:
from lazy_imports import LazyModule, as_package, load
load(
LazyModule(
*as_package(__file__),
("__version__", __version__),
("__all__", __all__),
"""# import apis into sdk package
# import apis into sdk package
from petstore_api.api.another_fake_api import AnotherFakeApi as AnotherFakeApi
from petstore_api.api.default_api import DefaultApi as DefaultApi
from petstore_api.api.fake_api import FakeApi as FakeApi
@ -431,8 +286,3 @@ from petstore_api.models.upload_file_with_additional_properties_request_object i
from petstore_api.models.user import User as User
from petstore_api.models.with_nested_one_of import WithNestedOneOf as WithNestedOneOf
""",
name=__name__,
doc=__doc__,
)
)

View File

@ -1,23 +1,6 @@
# flake8: noqa
if __import__("typing").TYPE_CHECKING:
# import apis into api package
from petstore_api.api.another_fake_api import AnotherFakeApi
from petstore_api.api.default_api import DefaultApi
from petstore_api.api.fake_api import FakeApi
from petstore_api.api.fake_classname_tags123_api import FakeClassnameTags123Api
from petstore_api.api.import_test_datetime_api import ImportTestDatetimeApi
from petstore_api.api.pet_api import PetApi
from petstore_api.api.store_api import StoreApi
from petstore_api.api.user_api import UserApi
else:
from lazy_imports import LazyModule, as_package, load
load(
LazyModule(
*as_package(__file__),
"""# import apis into api package
# import apis into api package
from petstore_api.api.another_fake_api import AnotherFakeApi
from petstore_api.api.default_api import DefaultApi
from petstore_api.api.fake_api import FakeApi
@ -27,8 +10,3 @@ from petstore_api.api.pet_api import PetApi
from petstore_api.api.store_api import StoreApi
from petstore_api.api.user_api import UserApi
""",
name=__name__,
doc=__doc__,
)
)

View File

@ -12,129 +12,7 @@
Do not edit the class manually.
""" # noqa: E501
if __import__("typing").TYPE_CHECKING:
# import models into model package
from petstore_api.models.additional_properties_any_type import AdditionalPropertiesAnyType
from petstore_api.models.additional_properties_class import AdditionalPropertiesClass
from petstore_api.models.additional_properties_object import AdditionalPropertiesObject
from petstore_api.models.additional_properties_with_description_only import AdditionalPropertiesWithDescriptionOnly
from petstore_api.models.all_of_super_model import AllOfSuperModel
from petstore_api.models.all_of_with_single_ref import AllOfWithSingleRef
from petstore_api.models.animal import Animal
from petstore_api.models.any_of_color import AnyOfColor
from petstore_api.models.any_of_pig import AnyOfPig
from petstore_api.models.array_of_array_of_model import ArrayOfArrayOfModel
from petstore_api.models.array_of_array_of_number_only import ArrayOfArrayOfNumberOnly
from petstore_api.models.array_of_number_only import ArrayOfNumberOnly
from petstore_api.models.array_test import ArrayTest
from petstore_api.models.base_discriminator import BaseDiscriminator
from petstore_api.models.basque_pig import BasquePig
from petstore_api.models.bathing import Bathing
from petstore_api.models.capitalization import Capitalization
from petstore_api.models.cat import Cat
from petstore_api.models.category import Category
from petstore_api.models.circular_all_of_ref import CircularAllOfRef
from petstore_api.models.circular_reference_model import CircularReferenceModel
from petstore_api.models.class_model import ClassModel
from petstore_api.models.client import Client
from petstore_api.models.color import Color
from petstore_api.models.creature import Creature
from petstore_api.models.creature_info import CreatureInfo
from petstore_api.models.danish_pig import DanishPig
from petstore_api.models.data_output_format import DataOutputFormat
from petstore_api.models.deprecated_object import DeprecatedObject
from petstore_api.models.discriminator_all_of_sub import DiscriminatorAllOfSub
from petstore_api.models.discriminator_all_of_super import DiscriminatorAllOfSuper
from petstore_api.models.dog import Dog
from petstore_api.models.dummy_model import DummyModel
from petstore_api.models.enum_arrays import EnumArrays
from petstore_api.models.enum_class import EnumClass
from petstore_api.models.enum_number_vendor_ext import EnumNumberVendorExt
from petstore_api.models.enum_ref_with_default_value import EnumRefWithDefaultValue
from petstore_api.models.enum_string1 import EnumString1
from petstore_api.models.enum_string2 import EnumString2
from petstore_api.models.enum_string_vendor_ext import EnumStringVendorExt
from petstore_api.models.enum_test import EnumTest
from petstore_api.models.feeding import Feeding
from petstore_api.models.file import File
from petstore_api.models.file_schema_test_class import FileSchemaTestClass
from petstore_api.models.first_ref import FirstRef
from petstore_api.models.foo import Foo
from petstore_api.models.foo_get_default_response import FooGetDefaultResponse
from petstore_api.models.format_test import FormatTest
from petstore_api.models.has_only_read_only import HasOnlyReadOnly
from petstore_api.models.health_check_result import HealthCheckResult
from petstore_api.models.hunting_dog import HuntingDog
from petstore_api.models.info import Info
from petstore_api.models.inner_dict_with_property import InnerDictWithProperty
from petstore_api.models.input_all_of import InputAllOf
from petstore_api.models.int_or_string import IntOrString
from petstore_api.models.list_class import ListClass
from petstore_api.models.map_of_array_of_model import MapOfArrayOfModel
from petstore_api.models.map_test import MapTest
from petstore_api.models.mixed_properties_and_additional_properties_class import MixedPropertiesAndAdditionalPropertiesClass
from petstore_api.models.model200_response import Model200Response
from petstore_api.models.model_api_response import ModelApiResponse
from petstore_api.models.model_field import ModelField
from petstore_api.models.model_return import ModelReturn
from petstore_api.models.multi_arrays import MultiArrays
from petstore_api.models.name import Name
from petstore_api.models.nullable_class import NullableClass
from petstore_api.models.nullable_property import NullableProperty
from petstore_api.models.number_only import NumberOnly
from petstore_api.models.object_to_test_additional_properties import ObjectToTestAdditionalProperties
from petstore_api.models.object_with_deprecated_fields import ObjectWithDeprecatedFields
from petstore_api.models.one_of_enum_string import OneOfEnumString
from petstore_api.models.order import Order
from petstore_api.models.outer_composite import OuterComposite
from petstore_api.models.outer_enum import OuterEnum
from petstore_api.models.outer_enum_default_value import OuterEnumDefaultValue
from petstore_api.models.outer_enum_integer import OuterEnumInteger
from petstore_api.models.outer_enum_integer_default_value import OuterEnumIntegerDefaultValue
from petstore_api.models.outer_object_with_enum_property import OuterObjectWithEnumProperty
from petstore_api.models.parent import Parent
from petstore_api.models.parent_with_optional_dict import ParentWithOptionalDict
from petstore_api.models.pet import Pet
from petstore_api.models.pig import Pig
from petstore_api.models.pony_sizes import PonySizes
from petstore_api.models.poop_cleaning import PoopCleaning
from petstore_api.models.primitive_string import PrimitiveString
from petstore_api.models.property_map import PropertyMap
from petstore_api.models.property_name_collision import PropertyNameCollision
from petstore_api.models.read_only_first import ReadOnlyFirst
from petstore_api.models.second_circular_all_of_ref import SecondCircularAllOfRef
from petstore_api.models.second_ref import SecondRef
from petstore_api.models.self_reference_model import SelfReferenceModel
from petstore_api.models.single_ref_type import SingleRefType
from petstore_api.models.special_character_enum import SpecialCharacterEnum
from petstore_api.models.special_model_name import SpecialModelName
from petstore_api.models.special_name import SpecialName
from petstore_api.models.tag import Tag
from petstore_api.models.task import Task
from petstore_api.models.task_activity import TaskActivity
from petstore_api.models.test_enum import TestEnum
from petstore_api.models.test_enum_with_default import TestEnumWithDefault
from petstore_api.models.test_error_responses_with_model400_response import TestErrorResponsesWithModel400Response
from petstore_api.models.test_error_responses_with_model404_response import TestErrorResponsesWithModel404Response
from petstore_api.models.test_inline_freeform_additional_properties_request import TestInlineFreeformAdditionalPropertiesRequest
from petstore_api.models.test_model_with_enum_default import TestModelWithEnumDefault
from petstore_api.models.test_object_for_multipart_requests_request_marker import TestObjectForMultipartRequestsRequestMarker
from petstore_api.models.tiger import Tiger
from petstore_api.models.type import Type
from petstore_api.models.unnamed_dict_with_additional_model_list_properties import UnnamedDictWithAdditionalModelListProperties
from petstore_api.models.unnamed_dict_with_additional_string_list_properties import UnnamedDictWithAdditionalStringListProperties
from petstore_api.models.upload_file_with_additional_properties_request_object import UploadFileWithAdditionalPropertiesRequestObject
from petstore_api.models.user import User
from petstore_api.models.with_nested_one_of import WithNestedOneOf
else:
from lazy_imports import LazyModule, as_package, load
load(
LazyModule(
*as_package(__file__),
"""# import models into model package
# import models into model package
from petstore_api.models.additional_properties_any_type import AdditionalPropertiesAnyType
from petstore_api.models.additional_properties_class import AdditionalPropertiesClass
from petstore_api.models.additional_properties_object import AdditionalPropertiesObject
@ -248,8 +126,3 @@ from petstore_api.models.upload_file_with_additional_properties_request_object i
from petstore_api.models.user import User
from petstore_api.models.with_nested_one_of import WithNestedOneOf
""",
name=__name__,
doc=__doc__,
)
)

View File

@ -19,7 +19,6 @@ pem = ">= 19.3.0"
pycryptodome = ">= 3.9.0"
pydantic = ">= 2"
typing-extensions = ">= 4.7.1"
lazy-imports = ">= 1, < 2"
[tool.poetry.dev-dependencies]
pytest = ">= 7.2.1"

View File

@ -6,4 +6,3 @@ pem >= 19.3.0
pycryptodome >= 3.9.0
pydantic >= 2
typing-extensions >= 4.7.1
lazy-imports >= 1, < 2

View File

@ -32,7 +32,6 @@ REQUIRES = [
"pycryptodome >= 3.9.0",
"pydantic >= 2",
"typing-extensions >= 4.7.1",
"lazy-imports >= 1, < 2",
]
setup(

View File

@ -13,11 +13,11 @@ class TestApiClient(unittest.IsolatedAsyncioTestCase):
async def test_ignore_operation_servers(self):
config = petstore_api.Configuration(host=HOST)
async with petstore_api.ApiClient(config) as client:
user_api_instance = petstore_api.api.user_api.UserApi(client)
user_api_instance = petstore_api.UserApi(client)
config_ignore = petstore_api.Configuration(host=HOST, ignore_operation_servers=True)
client_ignore = petstore_api.ApiClient(config_ignore)
user_api_instance_ignore = petstore_api.api.user_api.UserApi(client_ignore)
user_api_instance_ignore = petstore_api.UserApi(client_ignore)
params_to_serialize = {
'user': petstore_api.User(id=1, username='test'),

View 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

View 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

View 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

View File

@ -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

View File

@ -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

View File

@ -0,0 +1 @@
7.16.0-SNAPSHOT

View 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

View 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
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 = 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 \&quot;client\&quot; 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

View File

@ -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)

View File

@ -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)

View File

@ -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)

View File

@ -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)

View File

@ -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)

View File

@ -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)

View 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)

View File

@ -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
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 = 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)

View File

@ -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)

View File

@ -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)

View File

@ -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)

View File

@ -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)

View File

@ -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)

View File

@ -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)

View File

@ -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)

View File

@ -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)

View File

@ -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)

View File

@ -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)

View 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)

View File

@ -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)

View File

@ -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)

View File

@ -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)

View File

@ -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)

View 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)

View 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)

View File

@ -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)

View File

@ -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)

View File

@ -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)

View File

@ -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)

View File

@ -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
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 = 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)

View File

@ -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)

View File

@ -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)

View File

@ -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)

View 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)

View File

@ -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)

View File

@ -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)

View File

@ -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)

View File

@ -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)

View File

@ -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)

View File

@ -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)

View File

@ -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)

View File

@ -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)

View File

@ -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)

File diff suppressed because it is too large Load Diff

View File

@ -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
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 = 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)

View File

@ -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)

View 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)

View File

@ -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)

View File

@ -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)

View 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)

View File

@ -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)

View File

@ -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 &#39;image_&#39; (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)

View File

@ -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)

View File

@ -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)

View File

@ -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)

View File

@ -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
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 = 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)

View 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)

View File

@ -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)

View File

@ -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)

View File

@ -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)

View File

@ -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)

View File

@ -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)

View File

@ -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)

Some files were not shown because too many files have changed in this diff Show More