mirror of
https://github.com/OpenAPITools/openapi-generator.git
synced 2025-12-11 06:22:48 +00:00
Decommission python client generator (#15486)
* decomission python client generator * udpate * update doc
This commit is contained in:
William Cheng
GitHub
@@ -1,67 +0,0 @@
|
||||
# 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
|
||||
dev-requirements.txt.log
|
||||
|
||||
# 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
|
||||
@@ -1,24 +0,0 @@
|
||||
# ref: https://docs.gitlab.com/ee/ci/README.html
|
||||
|
||||
stages:
|
||||
- test
|
||||
|
||||
.tests:
|
||||
stage: test
|
||||
script:
|
||||
- pip install -r requirements.txt
|
||||
- pip install -r test-requirements.txt
|
||||
- pytest --cov=petstore_api
|
||||
|
||||
test-3.5:
|
||||
extends: .tests
|
||||
image: python:3.5-alpine
|
||||
test-3.6:
|
||||
extends: .tests
|
||||
image: python:3.6-alpine
|
||||
test-3.7:
|
||||
extends: .tests
|
||||
image: python:3.7-alpine
|
||||
test-3.8:
|
||||
extends: .tests
|
||||
image: python:3.8-alpine
|
||||
@@ -1,23 +0,0 @@
|
||||
# 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
|
||||
@@ -1,402 +0,0 @@
|
||||
.gitignore
|
||||
.gitlab-ci.yml
|
||||
.travis.yml
|
||||
README.md
|
||||
docs/apis/tags/AnotherFakeApi.md
|
||||
docs/apis/tags/DefaultApi.md
|
||||
docs/apis/tags/FakeApi.md
|
||||
docs/apis/tags/FakeClassnameTags123Api.md
|
||||
docs/apis/tags/PetApi.md
|
||||
docs/apis/tags/StoreApi.md
|
||||
docs/apis/tags/UserApi.md
|
||||
docs/models/AdditionalPropertiesClass.md
|
||||
docs/models/AdditionalPropertiesValidator.md
|
||||
docs/models/AdditionalPropertiesWithArrayOfEnums.md
|
||||
docs/models/Address.md
|
||||
docs/models/Animal.md
|
||||
docs/models/AnimalFarm.md
|
||||
docs/models/AnyTypeAndFormat.md
|
||||
docs/models/AnyTypeNotString.md
|
||||
docs/models/ApiResponse.md
|
||||
docs/models/Apple.md
|
||||
docs/models/AppleReq.md
|
||||
docs/models/ArrayHoldingAnyType.md
|
||||
docs/models/ArrayOfArrayOfNumberOnly.md
|
||||
docs/models/ArrayOfEnums.md
|
||||
docs/models/ArrayOfNumberOnly.md
|
||||
docs/models/ArrayTest.md
|
||||
docs/models/ArrayWithValidationsInItems.md
|
||||
docs/models/Banana.md
|
||||
docs/models/BananaReq.md
|
||||
docs/models/Bar.md
|
||||
docs/models/BasquePig.md
|
||||
docs/models/Boolean.md
|
||||
docs/models/BooleanEnum.md
|
||||
docs/models/Capitalization.md
|
||||
docs/models/Cat.md
|
||||
docs/models/Category.md
|
||||
docs/models/ChildCat.md
|
||||
docs/models/ClassModel.md
|
||||
docs/models/Client.md
|
||||
docs/models/ComplexQuadrilateral.md
|
||||
docs/models/ComposedAnyOfDifferentTypesNoValidations.md
|
||||
docs/models/ComposedArray.md
|
||||
docs/models/ComposedBool.md
|
||||
docs/models/ComposedNone.md
|
||||
docs/models/ComposedNumber.md
|
||||
docs/models/ComposedObject.md
|
||||
docs/models/ComposedOneOfDifferentTypes.md
|
||||
docs/models/ComposedString.md
|
||||
docs/models/Currency.md
|
||||
docs/models/DanishPig.md
|
||||
docs/models/DateTimeTest.md
|
||||
docs/models/DateTimeWithValidations.md
|
||||
docs/models/DateWithValidations.md
|
||||
docs/models/DecimalPayload.md
|
||||
docs/models/Dog.md
|
||||
docs/models/Drawing.md
|
||||
docs/models/EnumArrays.md
|
||||
docs/models/EnumClass.md
|
||||
docs/models/EnumTest.md
|
||||
docs/models/EquilateralTriangle.md
|
||||
docs/models/File.md
|
||||
docs/models/FileSchemaTestClass.md
|
||||
docs/models/Foo.md
|
||||
docs/models/FormatTest.md
|
||||
docs/models/FromSchema.md
|
||||
docs/models/Fruit.md
|
||||
docs/models/FruitReq.md
|
||||
docs/models/GmFruit.md
|
||||
docs/models/GrandparentAnimal.md
|
||||
docs/models/HasOnlyReadOnly.md
|
||||
docs/models/HealthCheckResult.md
|
||||
docs/models/IntegerEnum.md
|
||||
docs/models/IntegerEnumBig.md
|
||||
docs/models/IntegerEnumOneValue.md
|
||||
docs/models/IntegerEnumWithDefaultValue.md
|
||||
docs/models/IntegerMax10.md
|
||||
docs/models/IntegerMin15.md
|
||||
docs/models/IsoscelesTriangle.md
|
||||
docs/models/JSONPatchRequest.md
|
||||
docs/models/JSONPatchRequestAddReplaceTest.md
|
||||
docs/models/JSONPatchRequestMoveCopy.md
|
||||
docs/models/JSONPatchRequestRemove.md
|
||||
docs/models/Mammal.md
|
||||
docs/models/MapTest.md
|
||||
docs/models/MixedPropertiesAndAdditionalPropertiesClass.md
|
||||
docs/models/Model200Response.md
|
||||
docs/models/ModelReturn.md
|
||||
docs/models/Money.md
|
||||
docs/models/Name.md
|
||||
docs/models/NoAdditionalProperties.md
|
||||
docs/models/NullableClass.md
|
||||
docs/models/NullableShape.md
|
||||
docs/models/NullableString.md
|
||||
docs/models/Number.md
|
||||
docs/models/NumberOnly.md
|
||||
docs/models/NumberWithValidations.md
|
||||
docs/models/ObjectInterface.md
|
||||
docs/models/ObjectModelWithArgAndArgsProperties.md
|
||||
docs/models/ObjectModelWithRefProps.md
|
||||
docs/models/ObjectWithAllOfWithReqTestPropFromUnsetAddProp.md
|
||||
docs/models/ObjectWithDecimalProperties.md
|
||||
docs/models/ObjectWithDifficultlyNamedProps.md
|
||||
docs/models/ObjectWithInlineCompositionProperty.md
|
||||
docs/models/ObjectWithInvalidNamedRefedProperties.md
|
||||
docs/models/ObjectWithOptionalTestProp.md
|
||||
docs/models/ObjectWithValidations.md
|
||||
docs/models/Order.md
|
||||
docs/models/ParentPet.md
|
||||
docs/models/Pet.md
|
||||
docs/models/Pig.md
|
||||
docs/models/Player.md
|
||||
docs/models/Quadrilateral.md
|
||||
docs/models/QuadrilateralInterface.md
|
||||
docs/models/ReadOnlyFirst.md
|
||||
docs/models/ScaleneTriangle.md
|
||||
docs/models/Shape.md
|
||||
docs/models/ShapeOrNull.md
|
||||
docs/models/SimpleQuadrilateral.md
|
||||
docs/models/SomeObject.md
|
||||
docs/models/SpecialModelName.md
|
||||
docs/models/String.md
|
||||
docs/models/StringBooleanMap.md
|
||||
docs/models/StringEnum.md
|
||||
docs/models/StringEnumWithDefaultValue.md
|
||||
docs/models/StringWithValidation.md
|
||||
docs/models/Tag.md
|
||||
docs/models/Triangle.md
|
||||
docs/models/TriangleInterface.md
|
||||
docs/models/UUIDString.md
|
||||
docs/models/User.md
|
||||
docs/models/Whale.md
|
||||
docs/models/Zebra.md
|
||||
git_push.sh
|
||||
petstore_api/__init__.py
|
||||
petstore_api/api_client.py
|
||||
petstore_api/apis/__init__.py
|
||||
petstore_api/apis/tags/another_fake_api.py
|
||||
petstore_api/apis/tags/default_api.py
|
||||
petstore_api/apis/tags/fake_api.py
|
||||
petstore_api/apis/tags/fake_classname_tags123_api.py
|
||||
petstore_api/apis/tags/pet_api.py
|
||||
petstore_api/apis/tags/store_api.py
|
||||
petstore_api/apis/tags/user_api.py
|
||||
petstore_api/configuration.py
|
||||
petstore_api/exceptions.py
|
||||
petstore_api/model/__init__.py
|
||||
petstore_api/model/additional_properties_class.py
|
||||
petstore_api/model/additional_properties_class.pyi
|
||||
petstore_api/model/additional_properties_validator.py
|
||||
petstore_api/model/additional_properties_validator.pyi
|
||||
petstore_api/model/additional_properties_with_array_of_enums.py
|
||||
petstore_api/model/additional_properties_with_array_of_enums.pyi
|
||||
petstore_api/model/address.py
|
||||
petstore_api/model/address.pyi
|
||||
petstore_api/model/animal.py
|
||||
petstore_api/model/animal.pyi
|
||||
petstore_api/model/animal_farm.py
|
||||
petstore_api/model/animal_farm.pyi
|
||||
petstore_api/model/any_type_and_format.py
|
||||
petstore_api/model/any_type_and_format.pyi
|
||||
petstore_api/model/any_type_not_string.py
|
||||
petstore_api/model/any_type_not_string.pyi
|
||||
petstore_api/model/api_response.py
|
||||
petstore_api/model/api_response.pyi
|
||||
petstore_api/model/apple.py
|
||||
petstore_api/model/apple.pyi
|
||||
petstore_api/model/apple_req.py
|
||||
petstore_api/model/apple_req.pyi
|
||||
petstore_api/model/array_holding_any_type.py
|
||||
petstore_api/model/array_holding_any_type.pyi
|
||||
petstore_api/model/array_of_array_of_number_only.py
|
||||
petstore_api/model/array_of_array_of_number_only.pyi
|
||||
petstore_api/model/array_of_enums.py
|
||||
petstore_api/model/array_of_enums.pyi
|
||||
petstore_api/model/array_of_number_only.py
|
||||
petstore_api/model/array_of_number_only.pyi
|
||||
petstore_api/model/array_test.py
|
||||
petstore_api/model/array_test.pyi
|
||||
petstore_api/model/array_with_validations_in_items.py
|
||||
petstore_api/model/array_with_validations_in_items.pyi
|
||||
petstore_api/model/banana.py
|
||||
petstore_api/model/banana.pyi
|
||||
petstore_api/model/banana_req.py
|
||||
petstore_api/model/banana_req.pyi
|
||||
petstore_api/model/bar.py
|
||||
petstore_api/model/bar.pyi
|
||||
petstore_api/model/basque_pig.py
|
||||
petstore_api/model/basque_pig.pyi
|
||||
petstore_api/model/boolean.py
|
||||
petstore_api/model/boolean.pyi
|
||||
petstore_api/model/boolean_enum.py
|
||||
petstore_api/model/boolean_enum.pyi
|
||||
petstore_api/model/capitalization.py
|
||||
petstore_api/model/capitalization.pyi
|
||||
petstore_api/model/cat.py
|
||||
petstore_api/model/cat.pyi
|
||||
petstore_api/model/category.py
|
||||
petstore_api/model/category.pyi
|
||||
petstore_api/model/child_cat.py
|
||||
petstore_api/model/child_cat.pyi
|
||||
petstore_api/model/class_model.py
|
||||
petstore_api/model/class_model.pyi
|
||||
petstore_api/model/client.py
|
||||
petstore_api/model/client.pyi
|
||||
petstore_api/model/complex_quadrilateral.py
|
||||
petstore_api/model/complex_quadrilateral.pyi
|
||||
petstore_api/model/composed_any_of_different_types_no_validations.py
|
||||
petstore_api/model/composed_any_of_different_types_no_validations.pyi
|
||||
petstore_api/model/composed_array.py
|
||||
petstore_api/model/composed_array.pyi
|
||||
petstore_api/model/composed_bool.py
|
||||
petstore_api/model/composed_bool.pyi
|
||||
petstore_api/model/composed_none.py
|
||||
petstore_api/model/composed_none.pyi
|
||||
petstore_api/model/composed_number.py
|
||||
petstore_api/model/composed_number.pyi
|
||||
petstore_api/model/composed_object.py
|
||||
petstore_api/model/composed_object.pyi
|
||||
petstore_api/model/composed_one_of_different_types.py
|
||||
petstore_api/model/composed_one_of_different_types.pyi
|
||||
petstore_api/model/composed_string.py
|
||||
petstore_api/model/composed_string.pyi
|
||||
petstore_api/model/currency.py
|
||||
petstore_api/model/currency.pyi
|
||||
petstore_api/model/danish_pig.py
|
||||
petstore_api/model/danish_pig.pyi
|
||||
petstore_api/model/date_time_test.py
|
||||
petstore_api/model/date_time_test.pyi
|
||||
petstore_api/model/date_time_with_validations.py
|
||||
petstore_api/model/date_time_with_validations.pyi
|
||||
petstore_api/model/date_with_validations.py
|
||||
petstore_api/model/date_with_validations.pyi
|
||||
petstore_api/model/decimal_payload.py
|
||||
petstore_api/model/decimal_payload.pyi
|
||||
petstore_api/model/dog.py
|
||||
petstore_api/model/dog.pyi
|
||||
petstore_api/model/drawing.py
|
||||
petstore_api/model/drawing.pyi
|
||||
petstore_api/model/enum_arrays.py
|
||||
petstore_api/model/enum_arrays.pyi
|
||||
petstore_api/model/enum_class.py
|
||||
petstore_api/model/enum_class.pyi
|
||||
petstore_api/model/enum_test.py
|
||||
petstore_api/model/enum_test.pyi
|
||||
petstore_api/model/equilateral_triangle.py
|
||||
petstore_api/model/equilateral_triangle.pyi
|
||||
petstore_api/model/file.py
|
||||
petstore_api/model/file.pyi
|
||||
petstore_api/model/file_schema_test_class.py
|
||||
petstore_api/model/file_schema_test_class.pyi
|
||||
petstore_api/model/foo.py
|
||||
petstore_api/model/foo.pyi
|
||||
petstore_api/model/format_test.py
|
||||
petstore_api/model/format_test.pyi
|
||||
petstore_api/model/from_schema.py
|
||||
petstore_api/model/from_schema.pyi
|
||||
petstore_api/model/fruit.py
|
||||
petstore_api/model/fruit.pyi
|
||||
petstore_api/model/fruit_req.py
|
||||
petstore_api/model/fruit_req.pyi
|
||||
petstore_api/model/gm_fruit.py
|
||||
petstore_api/model/gm_fruit.pyi
|
||||
petstore_api/model/grandparent_animal.py
|
||||
petstore_api/model/grandparent_animal.pyi
|
||||
petstore_api/model/has_only_read_only.py
|
||||
petstore_api/model/has_only_read_only.pyi
|
||||
petstore_api/model/health_check_result.py
|
||||
petstore_api/model/health_check_result.pyi
|
||||
petstore_api/model/integer_enum.py
|
||||
petstore_api/model/integer_enum.pyi
|
||||
petstore_api/model/integer_enum_big.py
|
||||
petstore_api/model/integer_enum_big.pyi
|
||||
petstore_api/model/integer_enum_one_value.py
|
||||
petstore_api/model/integer_enum_one_value.pyi
|
||||
petstore_api/model/integer_enum_with_default_value.py
|
||||
petstore_api/model/integer_enum_with_default_value.pyi
|
||||
petstore_api/model/integer_max10.py
|
||||
petstore_api/model/integer_max10.pyi
|
||||
petstore_api/model/integer_min15.py
|
||||
petstore_api/model/integer_min15.pyi
|
||||
petstore_api/model/isosceles_triangle.py
|
||||
petstore_api/model/isosceles_triangle.pyi
|
||||
petstore_api/model/json_patch_request.py
|
||||
petstore_api/model/json_patch_request.pyi
|
||||
petstore_api/model/json_patch_request_add_replace_test.py
|
||||
petstore_api/model/json_patch_request_add_replace_test.pyi
|
||||
petstore_api/model/json_patch_request_move_copy.py
|
||||
petstore_api/model/json_patch_request_move_copy.pyi
|
||||
petstore_api/model/json_patch_request_remove.py
|
||||
petstore_api/model/json_patch_request_remove.pyi
|
||||
petstore_api/model/mammal.py
|
||||
petstore_api/model/mammal.pyi
|
||||
petstore_api/model/map_test.py
|
||||
petstore_api/model/map_test.pyi
|
||||
petstore_api/model/mixed_properties_and_additional_properties_class.py
|
||||
petstore_api/model/mixed_properties_and_additional_properties_class.pyi
|
||||
petstore_api/model/model200_response.py
|
||||
petstore_api/model/model200_response.pyi
|
||||
petstore_api/model/model_return.py
|
||||
petstore_api/model/model_return.pyi
|
||||
petstore_api/model/money.py
|
||||
petstore_api/model/money.pyi
|
||||
petstore_api/model/name.py
|
||||
petstore_api/model/name.pyi
|
||||
petstore_api/model/no_additional_properties.py
|
||||
petstore_api/model/no_additional_properties.pyi
|
||||
petstore_api/model/nullable_class.py
|
||||
petstore_api/model/nullable_class.pyi
|
||||
petstore_api/model/nullable_shape.py
|
||||
petstore_api/model/nullable_shape.pyi
|
||||
petstore_api/model/nullable_string.py
|
||||
petstore_api/model/nullable_string.pyi
|
||||
petstore_api/model/number.py
|
||||
petstore_api/model/number.pyi
|
||||
petstore_api/model/number_only.py
|
||||
petstore_api/model/number_only.pyi
|
||||
petstore_api/model/number_with_validations.py
|
||||
petstore_api/model/number_with_validations.pyi
|
||||
petstore_api/model/object_interface.py
|
||||
petstore_api/model/object_interface.pyi
|
||||
petstore_api/model/object_model_with_arg_and_args_properties.py
|
||||
petstore_api/model/object_model_with_arg_and_args_properties.pyi
|
||||
petstore_api/model/object_model_with_ref_props.py
|
||||
petstore_api/model/object_model_with_ref_props.pyi
|
||||
petstore_api/model/object_with_all_of_with_req_test_prop_from_unset_add_prop.py
|
||||
petstore_api/model/object_with_all_of_with_req_test_prop_from_unset_add_prop.pyi
|
||||
petstore_api/model/object_with_decimal_properties.py
|
||||
petstore_api/model/object_with_decimal_properties.pyi
|
||||
petstore_api/model/object_with_difficultly_named_props.py
|
||||
petstore_api/model/object_with_difficultly_named_props.pyi
|
||||
petstore_api/model/object_with_inline_composition_property.py
|
||||
petstore_api/model/object_with_inline_composition_property.pyi
|
||||
petstore_api/model/object_with_invalid_named_refed_properties.py
|
||||
petstore_api/model/object_with_invalid_named_refed_properties.pyi
|
||||
petstore_api/model/object_with_optional_test_prop.py
|
||||
petstore_api/model/object_with_optional_test_prop.pyi
|
||||
petstore_api/model/object_with_validations.py
|
||||
petstore_api/model/object_with_validations.pyi
|
||||
petstore_api/model/order.py
|
||||
petstore_api/model/order.pyi
|
||||
petstore_api/model/parent_pet.py
|
||||
petstore_api/model/parent_pet.pyi
|
||||
petstore_api/model/pet.py
|
||||
petstore_api/model/pet.pyi
|
||||
petstore_api/model/pig.py
|
||||
petstore_api/model/pig.pyi
|
||||
petstore_api/model/player.py
|
||||
petstore_api/model/player.pyi
|
||||
petstore_api/model/quadrilateral.py
|
||||
petstore_api/model/quadrilateral.pyi
|
||||
petstore_api/model/quadrilateral_interface.py
|
||||
petstore_api/model/quadrilateral_interface.pyi
|
||||
petstore_api/model/read_only_first.py
|
||||
petstore_api/model/read_only_first.pyi
|
||||
petstore_api/model/scalene_triangle.py
|
||||
petstore_api/model/scalene_triangle.pyi
|
||||
petstore_api/model/shape.py
|
||||
petstore_api/model/shape.pyi
|
||||
petstore_api/model/shape_or_null.py
|
||||
petstore_api/model/shape_or_null.pyi
|
||||
petstore_api/model/simple_quadrilateral.py
|
||||
petstore_api/model/simple_quadrilateral.pyi
|
||||
petstore_api/model/some_object.py
|
||||
petstore_api/model/some_object.pyi
|
||||
petstore_api/model/special_model_name.py
|
||||
petstore_api/model/special_model_name.pyi
|
||||
petstore_api/model/string.py
|
||||
petstore_api/model/string.pyi
|
||||
petstore_api/model/string_boolean_map.py
|
||||
petstore_api/model/string_boolean_map.pyi
|
||||
petstore_api/model/string_enum.py
|
||||
petstore_api/model/string_enum.pyi
|
||||
petstore_api/model/string_enum_with_default_value.py
|
||||
petstore_api/model/string_enum_with_default_value.pyi
|
||||
petstore_api/model/string_with_validation.py
|
||||
petstore_api/model/string_with_validation.pyi
|
||||
petstore_api/model/tag.py
|
||||
petstore_api/model/tag.pyi
|
||||
petstore_api/model/triangle.py
|
||||
petstore_api/model/triangle.pyi
|
||||
petstore_api/model/triangle_interface.py
|
||||
petstore_api/model/triangle_interface.pyi
|
||||
petstore_api/model/user.py
|
||||
petstore_api/model/user.pyi
|
||||
petstore_api/model/uuid_string.py
|
||||
petstore_api/model/uuid_string.pyi
|
||||
petstore_api/model/whale.py
|
||||
petstore_api/model/whale.pyi
|
||||
petstore_api/model/zebra.py
|
||||
petstore_api/model/zebra.pyi
|
||||
petstore_api/models/__init__.py
|
||||
petstore_api/rest.py
|
||||
petstore_api/schemas.py
|
||||
petstore_api/signing.py
|
||||
requirements.txt
|
||||
setup.cfg
|
||||
setup.py
|
||||
test-requirements.txt
|
||||
test/__init__.py
|
||||
test/test_models/__init__.py
|
||||
tox.ini
|
||||
@@ -1 +0,0 @@
|
||||
7.0.0-SNAPSHOT
|
||||
@@ -1,13 +0,0 @@
|
||||
# ref: https://docs.travis-ci.com/user/languages/python
|
||||
language: python
|
||||
python:
|
||||
- "3.5"
|
||||
- "3.6"
|
||||
- "3.7"
|
||||
- "3.8"
|
||||
# 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
|
||||
@@ -1,16 +0,0 @@
|
||||
REQUIREMENTS_FILE=dev-requirements.txt
|
||||
REQUIREMENTS_OUT=dev-requirements.txt.log
|
||||
SETUP_OUT=*.egg-info
|
||||
VENV=venv
|
||||
|
||||
clean:
|
||||
rm -rf $(REQUIREMENTS_OUT)
|
||||
rm -rf $(SETUP_OUT)
|
||||
rm -rf $(VENV)
|
||||
rm -rf .tox
|
||||
rm -rf .coverage
|
||||
find . -name "*.py[oc]" -delete
|
||||
find . -name "__pycache__" -delete
|
||||
|
||||
test: clean
|
||||
bash ./test_python.sh
|
||||
@@ -1,427 +0,0 @@
|
||||
# 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
|
||||
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
|
||||
|
||||
## Requirements.
|
||||
|
||||
Python >=3.7
|
||||
|
||||
## Migration from other generators like python and python-legacy
|
||||
|
||||
### Changes
|
||||
1. This generator uses spec case for all (object) property names and parameter names.
|
||||
- So if the spec has a property name like camelCase, it will use camelCase rather than camel_case
|
||||
- So you will need to update how you input and read properties to use spec case
|
||||
2. Endpoint parameters are stored in dictionaries to prevent collisions (explanation below)
|
||||
- So you will need to update how you pass data in to endpoints
|
||||
3. Endpoint responses now include the original response, the deserialized response body, and (todo)the deserialized headers
|
||||
- So you will need to update your code to use response.body to access deserialized data
|
||||
4. All validated data is instantiated in an instance that subclasses all validated Schema classes and Decimal/str/list/tuple/frozendict/NoneClass/BoolClass/bytes/io.FileIO
|
||||
- This means that you can use isinstance to check if a payload validated against a schema class
|
||||
- This means that no data will be of type None/True/False
|
||||
- ingested None will subclass NoneClass
|
||||
- ingested True will subclass BoolClass
|
||||
- ingested False will subclass BoolClass
|
||||
- So if you need to check is True/False/None, instead use instance.is_true_oapg()/.is_false_oapg()/.is_none_oapg()
|
||||
5. All validated class instances are immutable except for ones based on io.File
|
||||
- This is because if properties were changed after validation, that validation would no longer apply
|
||||
- So no changing values or property values after a class has been instantiated
|
||||
6. String + Number types with formats
|
||||
- String type data is stored as a string and if you need to access types based on its format like date,
|
||||
date-time, uuid, number etc then you will need to use accessor functions on the instance
|
||||
- type string + format: See .as_date_oapg, .as_datetime_oapg, .as_decimal_oapg, .as_uuid_oapg
|
||||
- type number + format: See .as_float_oapg, .as_int_oapg
|
||||
- this was done because openapi/json-schema defines constraints. string data may be type string with no format
|
||||
keyword in one schema, and include a format constraint in another schema
|
||||
- So if you need to access a string format based type, use as_date_oapg/as_datetime_oapg/as_decimal_oapg/as_uuid_oapg
|
||||
- So if you need to access a number format based type, use as_int_oapg/as_float_oapg
|
||||
7. Property access on AnyType(type unset) or object(dict) schemas
|
||||
- Only required keys with valid python names are properties like .someProp and have type hints
|
||||
- All optional keys may not exist, so properties are not defined for them
|
||||
- One can access optional values with dict_instance['optionalProp'] and KeyError will be raised if it does not exist
|
||||
- Use get_item_oapg if you need a way to always get a value whether or not the key exists
|
||||
- If the key does not exist, schemas.unset is returned from calling dict_instance.get_item_oapg('optionalProp')
|
||||
- All required and optional keys have type hints for this method, and @typing.overload is used
|
||||
- A type hint is also generated for additionalProperties accessed using this method
|
||||
- So you will need to update you code to use some_instance['optionalProp'] to access optional property
|
||||
and additionalProperty values
|
||||
8. The location of the api classes has changed
|
||||
- Api classes are located in your_package.apis.tags.some_api
|
||||
- This change was made to eliminate redundant code generation
|
||||
- Legacy generators generated the same endpoint twice if it had > 1 tag on it
|
||||
- This generator defines an endpoint in one class, then inherits that class to generate
|
||||
apis by tags and by paths
|
||||
- This change reduces code and allows quicker run time if you use the path apis
|
||||
- path apis are at your_package.apis.paths.some_path
|
||||
- Those apis will only load their needed models, which is less to load than all of the resources needed in a tag api
|
||||
- So you will need to update your import paths to the api classes
|
||||
|
||||
### Why are Oapg and _oapg used in class and method names?
|
||||
Classes can have arbitrarily named properties set on them
|
||||
Endpoints can have arbitrary operationId method names set
|
||||
For those reasons, I use the prefix Oapg and _oapg to greatly reduce the likelihood of collisions
|
||||
on protected + public classes/methods.
|
||||
oapg stands for OpenApi Python Generator.
|
||||
|
||||
### Object property spec case
|
||||
This was done because when payloads are ingested, they can be validated against N number of schemas.
|
||||
If the input signature used a different property name then that has mutated the payload.
|
||||
So SchemaA and SchemaB must both see the camelCase spec named variable.
|
||||
Also it is possible to send in two properties, named camelCase and camel_case in the same payload.
|
||||
That use case should be support so spec case is used.
|
||||
|
||||
### Parameter spec case
|
||||
Parameters can be included in different locations including:
|
||||
- query
|
||||
- path
|
||||
- header
|
||||
- cookie
|
||||
|
||||
Any of those parameters could use the same parameter names, so if every parameter
|
||||
was included as an endpoint parameter in a function signature, they would collide.
|
||||
For that reason, each of those inputs have been separated out into separate typed dictionaries:
|
||||
- query_params
|
||||
- path_params
|
||||
- header_params
|
||||
- cookie_params
|
||||
|
||||
So when updating your code, you will need to pass endpoint parameters in using those
|
||||
dictionaries.
|
||||
|
||||
### Endpoint responses
|
||||
Endpoint responses have been enriched to now include more information.
|
||||
Any response reom an endpoint will now include the following properties:
|
||||
response: urllib3.HTTPResponse
|
||||
body: typing.Union[Unset, Schema]
|
||||
headers: typing.Union[Unset, TODO]
|
||||
Note: response header deserialization has not yet been added
|
||||
|
||||
|
||||
## 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
|
||||
```
|
||||
|
||||
## Getting Started
|
||||
|
||||
Please follow the [installation procedure](#installation--usage) and then run the following:
|
||||
|
||||
```python
|
||||
import datetimeimport datetimeimport datetimeimport datetimeimport datetimeimport datetimeimport datetime
|
||||
import time
|
||||
import petstore_api
|
||||
from pprint import pprint
|
||||
from petstore_api.apis.tags import another_fake_api
|
||||
from petstore_api.model.client import Client
|
||||
# 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 = another_fake_api.AnotherFakeApi(api_client)
|
||||
client = Client(
|
||||
client="client_example",
|
||||
) # Client | client model
|
||||
|
||||
try:
|
||||
# To test special tags
|
||||
api_response = api_instance.call_123_test_special_tags(client)
|
||||
pprint(api_response)
|
||||
except petstore_api.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/apis/tags/AnotherFakeApi.md#call_123_test_special_tags) | **patch** /another-fake/dummy | To test special tags
|
||||
*DefaultApi* | [**foo_get**](docs/apis/tags/DefaultApi.md#foo_get) | **get** /foo |
|
||||
*FakeApi* | [**additional_properties_with_array_of_enums**](docs/apis/tags/FakeApi.md#additional_properties_with_array_of_enums) | **get** /fake/additional-properties-with-array-of-enums | Additional Properties with Array of Enums
|
||||
*FakeApi* | [**array_model**](docs/apis/tags/FakeApi.md#array_model) | **post** /fake/refs/arraymodel |
|
||||
*FakeApi* | [**array_of_enums**](docs/apis/tags/FakeApi.md#array_of_enums) | **post** /fake/refs/array-of-enums | Array of Enums
|
||||
*FakeApi* | [**body_with_file_schema**](docs/apis/tags/FakeApi.md#body_with_file_schema) | **put** /fake/body-with-file-schema |
|
||||
*FakeApi* | [**body_with_query_params**](docs/apis/tags/FakeApi.md#body_with_query_params) | **put** /fake/body-with-query-params |
|
||||
*FakeApi* | [**boolean**](docs/apis/tags/FakeApi.md#boolean) | **post** /fake/refs/boolean |
|
||||
*FakeApi* | [**case_sensitive_params**](docs/apis/tags/FakeApi.md#case_sensitive_params) | **put** /fake/case-sensitive-params |
|
||||
*FakeApi* | [**client_model**](docs/apis/tags/FakeApi.md#client_model) | **patch** /fake | To test \"client\" model
|
||||
*FakeApi* | [**composed_one_of_different_types**](docs/apis/tags/FakeApi.md#composed_one_of_different_types) | **post** /fake/refs/composed_one_of_number_with_validations |
|
||||
*FakeApi* | [**delete_coffee**](docs/apis/tags/FakeApi.md#delete_coffee) | **delete** /fake/deleteCoffee/{id} | Delete coffee
|
||||
*FakeApi* | [**endpoint_parameters**](docs/apis/tags/FakeApi.md#endpoint_parameters) | **post** /fake | Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
|
||||
*FakeApi* | [**enum_parameters**](docs/apis/tags/FakeApi.md#enum_parameters) | **get** /fake | To test enum parameters
|
||||
*FakeApi* | [**fake_health_get**](docs/apis/tags/FakeApi.md#fake_health_get) | **get** /fake/health | Health check endpoint
|
||||
*FakeApi* | [**group_parameters**](docs/apis/tags/FakeApi.md#group_parameters) | **delete** /fake | Fake endpoint to test group parameters (optional)
|
||||
*FakeApi* | [**inline_additional_properties**](docs/apis/tags/FakeApi.md#inline_additional_properties) | **post** /fake/inline-additionalProperties | test inline additionalProperties
|
||||
*FakeApi* | [**inline_composition**](docs/apis/tags/FakeApi.md#inline_composition) | **post** /fake/inlineComposition/ | testing composed schemas at inline locations
|
||||
*FakeApi* | [**json_form_data**](docs/apis/tags/FakeApi.md#json_form_data) | **get** /fake/jsonFormData | test json serialization of form data
|
||||
*FakeApi* | [**json_patch**](docs/apis/tags/FakeApi.md#json_patch) | **patch** /fake/jsonPatch | json patch
|
||||
*FakeApi* | [**json_with_charset**](docs/apis/tags/FakeApi.md#json_with_charset) | **post** /fake/jsonWithCharset | json with charset tx and rx
|
||||
*FakeApi* | [**mammal**](docs/apis/tags/FakeApi.md#mammal) | **post** /fake/refs/mammal |
|
||||
*FakeApi* | [**number_with_validations**](docs/apis/tags/FakeApi.md#number_with_validations) | **post** /fake/refs/number |
|
||||
*FakeApi* | [**object_in_query**](docs/apis/tags/FakeApi.md#object_in_query) | **get** /fake/objInQuery | user list
|
||||
*FakeApi* | [**object_model_with_ref_props**](docs/apis/tags/FakeApi.md#object_model_with_ref_props) | **post** /fake/refs/object_model_with_ref_props |
|
||||
*FakeApi* | [**parameter_collisions**](docs/apis/tags/FakeApi.md#parameter_collisions) | **post** /fake/parameterCollisions/{1}/{aB}/{Ab}/{self}/{A-B}/ | parameter collision case
|
||||
*FakeApi* | [**query_param_with_json_content_type**](docs/apis/tags/FakeApi.md#query_param_with_json_content_type) | **get** /fake/queryParamWithJsonContentType | query param with json content-type
|
||||
*FakeApi* | [**query_parameter_collection_format**](docs/apis/tags/FakeApi.md#query_parameter_collection_format) | **put** /fake/test-query-parameters |
|
||||
*FakeApi* | [**ref_object_in_query**](docs/apis/tags/FakeApi.md#ref_object_in_query) | **get** /fake/refObjInQuery | user list
|
||||
*FakeApi* | [**response_without_schema**](docs/apis/tags/FakeApi.md#response_without_schema) | **get** /fake/responseWithoutSchema | receives a response without schema
|
||||
*FakeApi* | [**string**](docs/apis/tags/FakeApi.md#string) | **post** /fake/refs/string |
|
||||
*FakeApi* | [**string_enum**](docs/apis/tags/FakeApi.md#string_enum) | **post** /fake/refs/enum |
|
||||
*FakeApi* | [**upload_download_file**](docs/apis/tags/FakeApi.md#upload_download_file) | **post** /fake/uploadDownloadFile | uploads a file and downloads a file using application/octet-stream
|
||||
*FakeApi* | [**upload_file**](docs/apis/tags/FakeApi.md#upload_file) | **post** /fake/uploadFile | uploads a file using multipart/form-data
|
||||
*FakeApi* | [**upload_files**](docs/apis/tags/FakeApi.md#upload_files) | **post** /fake/uploadFiles | uploads files using multipart/form-data
|
||||
*FakeClassnameTags123Api* | [**classname**](docs/apis/tags/FakeClassnameTags123Api.md#classname) | **patch** /fake_classname_test | To test class name in snake case
|
||||
*PetApi* | [**add_pet**](docs/apis/tags/PetApi.md#add_pet) | **post** /pet | Add a new pet to the store
|
||||
*PetApi* | [**delete_pet**](docs/apis/tags/PetApi.md#delete_pet) | **delete** /pet/{petId} | Deletes a pet
|
||||
*PetApi* | [**find_pets_by_status**](docs/apis/tags/PetApi.md#find_pets_by_status) | **get** /pet/findByStatus | Finds Pets by status
|
||||
*PetApi* | [**find_pets_by_tags**](docs/apis/tags/PetApi.md#find_pets_by_tags) | **get** /pet/findByTags | Finds Pets by tags
|
||||
*PetApi* | [**get_pet_by_id**](docs/apis/tags/PetApi.md#get_pet_by_id) | **get** /pet/{petId} | Find pet by ID
|
||||
*PetApi* | [**update_pet**](docs/apis/tags/PetApi.md#update_pet) | **put** /pet | Update an existing pet
|
||||
*PetApi* | [**update_pet_with_form**](docs/apis/tags/PetApi.md#update_pet_with_form) | **post** /pet/{petId} | Updates a pet in the store with form data
|
||||
*PetApi* | [**upload_file_with_required_file**](docs/apis/tags/PetApi.md#upload_file_with_required_file) | **post** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required)
|
||||
*PetApi* | [**upload_image**](docs/apis/tags/PetApi.md#upload_image) | **post** /pet/{petId}/uploadImage | uploads an image
|
||||
*StoreApi* | [**delete_order**](docs/apis/tags/StoreApi.md#delete_order) | **delete** /store/order/{order_id} | Delete purchase order by ID
|
||||
*StoreApi* | [**get_inventory**](docs/apis/tags/StoreApi.md#get_inventory) | **get** /store/inventory | Returns pet inventories by status
|
||||
*StoreApi* | [**get_order_by_id**](docs/apis/tags/StoreApi.md#get_order_by_id) | **get** /store/order/{order_id} | Find purchase order by ID
|
||||
*StoreApi* | [**place_order**](docs/apis/tags/StoreApi.md#place_order) | **post** /store/order | Place an order for a pet
|
||||
*UserApi* | [**create_user**](docs/apis/tags/UserApi.md#create_user) | **post** /user | Create user
|
||||
*UserApi* | [**create_users_with_array_input**](docs/apis/tags/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/apis/tags/UserApi.md#create_users_with_list_input) | **post** /user/createWithList | Creates list of users with given input array
|
||||
*UserApi* | [**delete_user**](docs/apis/tags/UserApi.md#delete_user) | **delete** /user/{username} | Delete user
|
||||
*UserApi* | [**get_user_by_name**](docs/apis/tags/UserApi.md#get_user_by_name) | **get** /user/{username} | Get user by user name
|
||||
*UserApi* | [**login_user**](docs/apis/tags/UserApi.md#login_user) | **get** /user/login | Logs user into the system
|
||||
*UserApi* | [**logout_user**](docs/apis/tags/UserApi.md#logout_user) | **get** /user/logout | Logs out current logged in user session
|
||||
*UserApi* | [**update_user**](docs/apis/tags/UserApi.md#update_user) | **put** /user/{username} | Updated user
|
||||
|
||||
## Documentation For Models
|
||||
|
||||
- [AdditionalPropertiesClass](docs/models/AdditionalPropertiesClass.md)
|
||||
- [AdditionalPropertiesValidator](docs/models/AdditionalPropertiesValidator.md)
|
||||
- [AdditionalPropertiesWithArrayOfEnums](docs/models/AdditionalPropertiesWithArrayOfEnums.md)
|
||||
- [Address](docs/models/Address.md)
|
||||
- [Animal](docs/models/Animal.md)
|
||||
- [AnimalFarm](docs/models/AnimalFarm.md)
|
||||
- [AnyTypeAndFormat](docs/models/AnyTypeAndFormat.md)
|
||||
- [AnyTypeNotString](docs/models/AnyTypeNotString.md)
|
||||
- [ApiResponse](docs/models/ApiResponse.md)
|
||||
- [Apple](docs/models/Apple.md)
|
||||
- [AppleReq](docs/models/AppleReq.md)
|
||||
- [ArrayHoldingAnyType](docs/models/ArrayHoldingAnyType.md)
|
||||
- [ArrayOfArrayOfNumberOnly](docs/models/ArrayOfArrayOfNumberOnly.md)
|
||||
- [ArrayOfEnums](docs/models/ArrayOfEnums.md)
|
||||
- [ArrayOfNumberOnly](docs/models/ArrayOfNumberOnly.md)
|
||||
- [ArrayTest](docs/models/ArrayTest.md)
|
||||
- [ArrayWithValidationsInItems](docs/models/ArrayWithValidationsInItems.md)
|
||||
- [Banana](docs/models/Banana.md)
|
||||
- [BananaReq](docs/models/BananaReq.md)
|
||||
- [Bar](docs/models/Bar.md)
|
||||
- [BasquePig](docs/models/BasquePig.md)
|
||||
- [Boolean](docs/models/Boolean.md)
|
||||
- [BooleanEnum](docs/models/BooleanEnum.md)
|
||||
- [Capitalization](docs/models/Capitalization.md)
|
||||
- [Cat](docs/models/Cat.md)
|
||||
- [Category](docs/models/Category.md)
|
||||
- [ChildCat](docs/models/ChildCat.md)
|
||||
- [ClassModel](docs/models/ClassModel.md)
|
||||
- [Client](docs/models/Client.md)
|
||||
- [ComplexQuadrilateral](docs/models/ComplexQuadrilateral.md)
|
||||
- [ComposedAnyOfDifferentTypesNoValidations](docs/models/ComposedAnyOfDifferentTypesNoValidations.md)
|
||||
- [ComposedArray](docs/models/ComposedArray.md)
|
||||
- [ComposedBool](docs/models/ComposedBool.md)
|
||||
- [ComposedNone](docs/models/ComposedNone.md)
|
||||
- [ComposedNumber](docs/models/ComposedNumber.md)
|
||||
- [ComposedObject](docs/models/ComposedObject.md)
|
||||
- [ComposedOneOfDifferentTypes](docs/models/ComposedOneOfDifferentTypes.md)
|
||||
- [ComposedString](docs/models/ComposedString.md)
|
||||
- [Currency](docs/models/Currency.md)
|
||||
- [DanishPig](docs/models/DanishPig.md)
|
||||
- [DateTimeTest](docs/models/DateTimeTest.md)
|
||||
- [DateTimeWithValidations](docs/models/DateTimeWithValidations.md)
|
||||
- [DateWithValidations](docs/models/DateWithValidations.md)
|
||||
- [DecimalPayload](docs/models/DecimalPayload.md)
|
||||
- [Dog](docs/models/Dog.md)
|
||||
- [Drawing](docs/models/Drawing.md)
|
||||
- [EnumArrays](docs/models/EnumArrays.md)
|
||||
- [EnumClass](docs/models/EnumClass.md)
|
||||
- [EnumTest](docs/models/EnumTest.md)
|
||||
- [EquilateralTriangle](docs/models/EquilateralTriangle.md)
|
||||
- [File](docs/models/File.md)
|
||||
- [FileSchemaTestClass](docs/models/FileSchemaTestClass.md)
|
||||
- [Foo](docs/models/Foo.md)
|
||||
- [FormatTest](docs/models/FormatTest.md)
|
||||
- [FromSchema](docs/models/FromSchema.md)
|
||||
- [Fruit](docs/models/Fruit.md)
|
||||
- [FruitReq](docs/models/FruitReq.md)
|
||||
- [GmFruit](docs/models/GmFruit.md)
|
||||
- [GrandparentAnimal](docs/models/GrandparentAnimal.md)
|
||||
- [HasOnlyReadOnly](docs/models/HasOnlyReadOnly.md)
|
||||
- [HealthCheckResult](docs/models/HealthCheckResult.md)
|
||||
- [IntegerEnum](docs/models/IntegerEnum.md)
|
||||
- [IntegerEnumBig](docs/models/IntegerEnumBig.md)
|
||||
- [IntegerEnumOneValue](docs/models/IntegerEnumOneValue.md)
|
||||
- [IntegerEnumWithDefaultValue](docs/models/IntegerEnumWithDefaultValue.md)
|
||||
- [IntegerMax10](docs/models/IntegerMax10.md)
|
||||
- [IntegerMin15](docs/models/IntegerMin15.md)
|
||||
- [IsoscelesTriangle](docs/models/IsoscelesTriangle.md)
|
||||
- [JSONPatchRequest](docs/models/JSONPatchRequest.md)
|
||||
- [JSONPatchRequestAddReplaceTest](docs/models/JSONPatchRequestAddReplaceTest.md)
|
||||
- [JSONPatchRequestMoveCopy](docs/models/JSONPatchRequestMoveCopy.md)
|
||||
- [JSONPatchRequestRemove](docs/models/JSONPatchRequestRemove.md)
|
||||
- [Mammal](docs/models/Mammal.md)
|
||||
- [MapTest](docs/models/MapTest.md)
|
||||
- [MixedPropertiesAndAdditionalPropertiesClass](docs/models/MixedPropertiesAndAdditionalPropertiesClass.md)
|
||||
- [Model200Response](docs/models/Model200Response.md)
|
||||
- [ModelReturn](docs/models/ModelReturn.md)
|
||||
- [Money](docs/models/Money.md)
|
||||
- [Name](docs/models/Name.md)
|
||||
- [NoAdditionalProperties](docs/models/NoAdditionalProperties.md)
|
||||
- [NullableClass](docs/models/NullableClass.md)
|
||||
- [NullableShape](docs/models/NullableShape.md)
|
||||
- [NullableString](docs/models/NullableString.md)
|
||||
- [Number](docs/models/Number.md)
|
||||
- [NumberOnly](docs/models/NumberOnly.md)
|
||||
- [NumberWithValidations](docs/models/NumberWithValidations.md)
|
||||
- [ObjectInterface](docs/models/ObjectInterface.md)
|
||||
- [ObjectModelWithArgAndArgsProperties](docs/models/ObjectModelWithArgAndArgsProperties.md)
|
||||
- [ObjectModelWithRefProps](docs/models/ObjectModelWithRefProps.md)
|
||||
- [ObjectWithAllOfWithReqTestPropFromUnsetAddProp](docs/models/ObjectWithAllOfWithReqTestPropFromUnsetAddProp.md)
|
||||
- [ObjectWithDecimalProperties](docs/models/ObjectWithDecimalProperties.md)
|
||||
- [ObjectWithDifficultlyNamedProps](docs/models/ObjectWithDifficultlyNamedProps.md)
|
||||
- [ObjectWithInlineCompositionProperty](docs/models/ObjectWithInlineCompositionProperty.md)
|
||||
- [ObjectWithInvalidNamedRefedProperties](docs/models/ObjectWithInvalidNamedRefedProperties.md)
|
||||
- [ObjectWithOptionalTestProp](docs/models/ObjectWithOptionalTestProp.md)
|
||||
- [ObjectWithValidations](docs/models/ObjectWithValidations.md)
|
||||
- [Order](docs/models/Order.md)
|
||||
- [ParentPet](docs/models/ParentPet.md)
|
||||
- [Pet](docs/models/Pet.md)
|
||||
- [Pig](docs/models/Pig.md)
|
||||
- [Player](docs/models/Player.md)
|
||||
- [Quadrilateral](docs/models/Quadrilateral.md)
|
||||
- [QuadrilateralInterface](docs/models/QuadrilateralInterface.md)
|
||||
- [ReadOnlyFirst](docs/models/ReadOnlyFirst.md)
|
||||
- [ScaleneTriangle](docs/models/ScaleneTriangle.md)
|
||||
- [Shape](docs/models/Shape.md)
|
||||
- [ShapeOrNull](docs/models/ShapeOrNull.md)
|
||||
- [SimpleQuadrilateral](docs/models/SimpleQuadrilateral.md)
|
||||
- [SomeObject](docs/models/SomeObject.md)
|
||||
- [SpecialModelName](docs/models/SpecialModelName.md)
|
||||
- [String](docs/models/String.md)
|
||||
- [StringBooleanMap](docs/models/StringBooleanMap.md)
|
||||
- [StringEnum](docs/models/StringEnum.md)
|
||||
- [StringEnumWithDefaultValue](docs/models/StringEnumWithDefaultValue.md)
|
||||
- [StringWithValidation](docs/models/StringWithValidation.md)
|
||||
- [Tag](docs/models/Tag.md)
|
||||
- [Triangle](docs/models/Triangle.md)
|
||||
- [TriangleInterface](docs/models/TriangleInterface.md)
|
||||
- [UUIDString](docs/models/UUIDString.md)
|
||||
- [User](docs/models/User.md)
|
||||
- [Whale](docs/models/Whale.md)
|
||||
- [Zebra](docs/models/Zebra.md)
|
||||
|
||||
## 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
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Notes for Large OpenAPI documents
|
||||
If the OpenAPI document is large, imports in petstore_api.apis and petstore_api.models may fail with a
|
||||
RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:
|
||||
|
||||
Solution 1:
|
||||
Use specific imports for apis and models like:
|
||||
- `from petstore_api.apis.default_api import DefaultApi`
|
||||
- `from petstore_api.model.pet import Pet`
|
||||
|
||||
Solution 1:
|
||||
Before importing the package, adjust the maximum recursion limit as shown below:
|
||||
```
|
||||
import sys
|
||||
sys.setrecursionlimit(1500)
|
||||
import petstore_api
|
||||
from petstore_api.apis import *
|
||||
from petstore_api.models import *
|
||||
```
|
||||
@@ -1,2 +0,0 @@
|
||||
tox
|
||||
flake8
|
||||
@@ -1,93 +0,0 @@
|
||||
<a id="__pageTop"></a>
|
||||
# petstore_api.apis.tags.another_fake_api.AnotherFakeApi
|
||||
|
||||
All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**call_123_test_special_tags**](#call_123_test_special_tags) | **patch** /another-fake/dummy | To test special tags
|
||||
|
||||
# **call_123_test_special_tags**
|
||||
<a id="call_123_test_special_tags"></a>
|
||||
> 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.apis.tags import another_fake_api
|
||||
from petstore_api.model.client import Client
|
||||
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 = another_fake_api.AnotherFakeApi(api_client)
|
||||
|
||||
# example passing only required values which don't have defaults set
|
||||
body = Client(
|
||||
client="client_example",
|
||||
)
|
||||
try:
|
||||
# To test special tags
|
||||
api_response = api_instance.call_123_test_special_tags(
|
||||
body=body,
|
||||
)
|
||||
pprint(api_response)
|
||||
except petstore_api.ApiException as e:
|
||||
print("Exception when calling AnotherFakeApi->call_123_test_special_tags: %s\n" % e)
|
||||
```
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
body | typing.Union[SchemaForRequestBodyApplicationJson] | required |
|
||||
content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body
|
||||
accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client
|
||||
stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file
|
||||
timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client
|
||||
skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned
|
||||
|
||||
### body
|
||||
|
||||
# SchemaForRequestBodyApplicationJson
|
||||
Type | Description | Notes
|
||||
------------- | ------------- | -------------
|
||||
[**Client**](../../models/Client.md) | |
|
||||
|
||||
|
||||
### Return Types, Responses
|
||||
|
||||
Code | Class | Description
|
||||
------------- | ------------- | -------------
|
||||
n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned
|
||||
200 | [ApiResponseFor200](#call_123_test_special_tags.ApiResponseFor200) | successful operation
|
||||
|
||||
#### call_123_test_special_tags.ApiResponseFor200
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
response | urllib3.HTTPResponse | Raw response |
|
||||
body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | |
|
||||
headers | Unset | headers were not defined |
|
||||
|
||||
# SchemaFor200ResponseBodyApplicationJson
|
||||
Type | Description | Notes
|
||||
------------- | ------------- | -------------
|
||||
[**Client**](../../models/Client.md) | |
|
||||
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
|
||||
|
||||
@@ -1,76 +0,0 @@
|
||||
<a id="__pageTop"></a>
|
||||
# petstore_api.apis.tags.default_api.DefaultApi
|
||||
|
||||
All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**foo_get**](#foo_get) | **get** /foo |
|
||||
|
||||
# **foo_get**
|
||||
<a id="foo_get"></a>
|
||||
> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} foo_get()
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
import petstore_api
|
||||
from petstore_api.apis.tags import default_api
|
||||
from petstore_api.model.foo import Foo
|
||||
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 = default_api.DefaultApi(api_client)
|
||||
|
||||
# example, this endpoint has no required or optional parameters
|
||||
try:
|
||||
api_response = api_instance.foo_get()
|
||||
pprint(api_response)
|
||||
except petstore_api.ApiException as e:
|
||||
print("Exception when calling DefaultApi->foo_get: %s\n" % e)
|
||||
```
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return Types, Responses
|
||||
|
||||
Code | Class | Description
|
||||
------------- | ------------- | -------------
|
||||
n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned
|
||||
default | [ApiResponseForDefault](#foo_get.ApiResponseForDefault) | response
|
||||
|
||||
#### foo_get.ApiResponseForDefault
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
response | urllib3.HTTPResponse | Raw response |
|
||||
body | typing.Union[SchemaFor0ResponseBodyApplicationJson, ] | |
|
||||
headers | Unset | headers were not defined |
|
||||
|
||||
# SchemaFor0ResponseBodyApplicationJson
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**string** | [**Foo**]({{complexTypePrefix}}Foo.md) | [**Foo**]({{complexTypePrefix}}Foo.md) | | [optional]
|
||||
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,104 +0,0 @@
|
||||
<a id="__pageTop"></a>
|
||||
# petstore_api.apis.tags.fake_classname_tags123_api.FakeClassnameTags123Api
|
||||
|
||||
All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**classname**](#classname) | **patch** /fake_classname_test | To test class name in snake case
|
||||
|
||||
# **classname**
|
||||
<a id="classname"></a>
|
||||
> Client 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.apis.tags import fake_classname_tags123_api
|
||||
from petstore_api.model.client import Client
|
||||
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'] = 'YOUR_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 = fake_classname_tags123_api.FakeClassnameTags123Api(api_client)
|
||||
|
||||
# example passing only required values which don't have defaults set
|
||||
body = Client(
|
||||
client="client_example",
|
||||
)
|
||||
try:
|
||||
# To test class name in snake case
|
||||
api_response = api_instance.classname(
|
||||
body=body,
|
||||
)
|
||||
pprint(api_response)
|
||||
except petstore_api.ApiException as e:
|
||||
print("Exception when calling FakeClassnameTags123Api->classname: %s\n" % e)
|
||||
```
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
body | typing.Union[SchemaForRequestBodyApplicationJson] | required |
|
||||
content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body
|
||||
accept_content_types | typing.Tuple[str] | default is ('application/json', ) | Tells the server the content type(s) that are accepted by the client
|
||||
stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file
|
||||
timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client
|
||||
skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned
|
||||
|
||||
### body
|
||||
|
||||
# SchemaForRequestBodyApplicationJson
|
||||
Type | Description | Notes
|
||||
------------- | ------------- | -------------
|
||||
[**Client**](../../models/Client.md) | |
|
||||
|
||||
|
||||
### Return Types, Responses
|
||||
|
||||
Code | Class | Description
|
||||
------------- | ------------- | -------------
|
||||
n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned
|
||||
200 | [ApiResponseFor200](#classname.ApiResponseFor200) | successful operation
|
||||
|
||||
#### classname.ApiResponseFor200
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
response | urllib3.HTTPResponse | Raw response |
|
||||
body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | |
|
||||
headers | Unset | headers were not defined |
|
||||
|
||||
# SchemaFor200ResponseBodyApplicationJson
|
||||
Type | Description | Notes
|
||||
------------- | ------------- | -------------
|
||||
[**Client**](../../models/Client.md) | |
|
||||
|
||||
|
||||
### Authorization
|
||||
|
||||
[api_key_query](../../../README.md#api_key_query)
|
||||
|
||||
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,391 +0,0 @@
|
||||
<a id="__pageTop"></a>
|
||||
# petstore_api.apis.tags.store_api.StoreApi
|
||||
|
||||
All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**delete_order**](#delete_order) | **delete** /store/order/{order_id} | Delete purchase order by ID
|
||||
[**get_inventory**](#get_inventory) | **get** /store/inventory | Returns pet inventories by status
|
||||
[**get_order_by_id**](#get_order_by_id) | **get** /store/order/{order_id} | Find purchase order by ID
|
||||
[**place_order**](#place_order) | **post** /store/order | Place an order for a pet
|
||||
|
||||
# **delete_order**
|
||||
<a id="delete_order"></a>
|
||||
> delete_order(order_id)
|
||||
|
||||
Delete purchase order by ID
|
||||
|
||||
For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
import petstore_api
|
||||
from petstore_api.apis.tags import store_api
|
||||
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 = store_api.StoreApi(api_client)
|
||||
|
||||
# example passing only required values which don't have defaults set
|
||||
path_params = {
|
||||
'order_id': "order_id_example",
|
||||
}
|
||||
try:
|
||||
# Delete purchase order by ID
|
||||
api_response = api_instance.delete_order(
|
||||
path_params=path_params,
|
||||
)
|
||||
except petstore_api.ApiException as e:
|
||||
print("Exception when calling StoreApi->delete_order: %s\n" % e)
|
||||
```
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
path_params | RequestPathParams | |
|
||||
stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file
|
||||
timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client
|
||||
skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned
|
||||
|
||||
### path_params
|
||||
#### RequestPathParams
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
order_id | OrderIdSchema | |
|
||||
|
||||
# OrderIdSchema
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
str, | str, | |
|
||||
|
||||
### Return Types, Responses
|
||||
|
||||
Code | Class | Description
|
||||
------------- | ------------- | -------------
|
||||
n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned
|
||||
400 | [ApiResponseFor400](#delete_order.ApiResponseFor400) | Invalid ID supplied
|
||||
404 | [ApiResponseFor404](#delete_order.ApiResponseFor404) | Order not found
|
||||
|
||||
#### delete_order.ApiResponseFor400
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
response | urllib3.HTTPResponse | Raw response |
|
||||
body | Unset | body was not defined |
|
||||
headers | Unset | headers were not defined |
|
||||
|
||||
#### delete_order.ApiResponseFor404
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
response | urllib3.HTTPResponse | Raw response |
|
||||
body | Unset | body was not defined |
|
||||
headers | Unset | headers were not defined |
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
|
||||
|
||||
# **get_inventory**
|
||||
<a id="get_inventory"></a>
|
||||
> {str: (int,)} get_inventory()
|
||||
|
||||
Returns pet inventories by status
|
||||
|
||||
Returns a map of status codes to quantities
|
||||
|
||||
### Example
|
||||
|
||||
* Api Key Authentication (api_key):
|
||||
```python
|
||||
import petstore_api
|
||||
from petstore_api.apis.tags import store_api
|
||||
from pprint import pprint
|
||||
# Defining the host is optional and defaults to http://petstore.swagger.io:80/v2
|
||||
# See configuration.py for a list of all supported configuration parameters.
|
||||
configuration = petstore_api.Configuration(
|
||||
host = "http://petstore.swagger.io:80/v2"
|
||||
)
|
||||
|
||||
# The client must configure the authentication and authorization parameters
|
||||
# in accordance with the API server security policy.
|
||||
# Examples for each auth method are provided below, use the example that
|
||||
# satisfies your auth use case.
|
||||
|
||||
# Configure API key authorization: api_key
|
||||
configuration.api_key['api_key'] = 'YOUR_API_KEY'
|
||||
|
||||
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
||||
# configuration.api_key_prefix['api_key'] = 'Bearer'
|
||||
# Enter a context with an instance of the API client
|
||||
with petstore_api.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = store_api.StoreApi(api_client)
|
||||
|
||||
# example, this endpoint has no required or optional parameters
|
||||
try:
|
||||
# Returns pet inventories by status
|
||||
api_response = api_instance.get_inventory()
|
||||
pprint(api_response)
|
||||
except petstore_api.ApiException as e:
|
||||
print("Exception when calling StoreApi->get_inventory: %s\n" % e)
|
||||
```
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return Types, Responses
|
||||
|
||||
Code | Class | Description
|
||||
------------- | ------------- | -------------
|
||||
n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned
|
||||
200 | [ApiResponseFor200](#get_inventory.ApiResponseFor200) | successful operation
|
||||
|
||||
#### get_inventory.ApiResponseFor200
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
response | urllib3.HTTPResponse | Raw response |
|
||||
body | typing.Union[SchemaFor200ResponseBodyApplicationJson, ] | |
|
||||
headers | Unset | headers were not defined |
|
||||
|
||||
# SchemaFor200ResponseBodyApplicationJson
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**any_string_name** | decimal.Decimal, int, | decimal.Decimal, | any string name can be used but the value must be the correct type | [optional] value must be a 32 bit integer
|
||||
|
||||
### Authorization
|
||||
|
||||
[api_key](../../../README.md#api_key)
|
||||
|
||||
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
|
||||
|
||||
# **get_order_by_id**
|
||||
<a id="get_order_by_id"></a>
|
||||
> Order get_order_by_id(order_id)
|
||||
|
||||
Find purchase order by ID
|
||||
|
||||
For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
import petstore_api
|
||||
from petstore_api.apis.tags import store_api
|
||||
from petstore_api.model.order import Order
|
||||
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 = store_api.StoreApi(api_client)
|
||||
|
||||
# example passing only required values which don't have defaults set
|
||||
path_params = {
|
||||
'order_id': 1,
|
||||
}
|
||||
try:
|
||||
# Find purchase order by ID
|
||||
api_response = api_instance.get_order_by_id(
|
||||
path_params=path_params,
|
||||
)
|
||||
pprint(api_response)
|
||||
except petstore_api.ApiException as e:
|
||||
print("Exception when calling StoreApi->get_order_by_id: %s\n" % e)
|
||||
```
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
path_params | RequestPathParams | |
|
||||
accept_content_types | typing.Tuple[str] | default is ('application/xml', 'application/json', ) | Tells the server the content type(s) that are accepted by the client
|
||||
stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file
|
||||
timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client
|
||||
skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned
|
||||
|
||||
### path_params
|
||||
#### RequestPathParams
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
order_id | OrderIdSchema | |
|
||||
|
||||
# OrderIdSchema
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
decimal.Decimal, int, | decimal.Decimal, | | value must be a 64 bit integer
|
||||
|
||||
### Return Types, Responses
|
||||
|
||||
Code | Class | Description
|
||||
------------- | ------------- | -------------
|
||||
n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned
|
||||
200 | [ApiResponseFor200](#get_order_by_id.ApiResponseFor200) | successful operation
|
||||
400 | [ApiResponseFor400](#get_order_by_id.ApiResponseFor400) | Invalid ID supplied
|
||||
404 | [ApiResponseFor404](#get_order_by_id.ApiResponseFor404) | Order not found
|
||||
|
||||
#### get_order_by_id.ApiResponseFor200
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
response | urllib3.HTTPResponse | Raw response |
|
||||
body | typing.Union[SchemaFor200ResponseBodyApplicationXml, SchemaFor200ResponseBodyApplicationJson, ] | |
|
||||
headers | Unset | headers were not defined |
|
||||
|
||||
# SchemaFor200ResponseBodyApplicationXml
|
||||
Type | Description | Notes
|
||||
------------- | ------------- | -------------
|
||||
[**Order**](../../models/Order.md) | |
|
||||
|
||||
|
||||
# SchemaFor200ResponseBodyApplicationJson
|
||||
Type | Description | Notes
|
||||
------------- | ------------- | -------------
|
||||
[**Order**](../../models/Order.md) | |
|
||||
|
||||
|
||||
#### get_order_by_id.ApiResponseFor400
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
response | urllib3.HTTPResponse | Raw response |
|
||||
body | Unset | body was not defined |
|
||||
headers | Unset | headers were not defined |
|
||||
|
||||
#### get_order_by_id.ApiResponseFor404
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
response | urllib3.HTTPResponse | Raw response |
|
||||
body | Unset | body was not defined |
|
||||
headers | Unset | headers were not defined |
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
|
||||
|
||||
# **place_order**
|
||||
<a id="place_order"></a>
|
||||
> Order place_order(order)
|
||||
|
||||
Place an order for a pet
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
import petstore_api
|
||||
from petstore_api.apis.tags import store_api
|
||||
from petstore_api.model.order import Order
|
||||
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 = store_api.StoreApi(api_client)
|
||||
|
||||
# example passing only required values which don't have defaults set
|
||||
body = Order(
|
||||
id=1,
|
||||
pet_id=1,
|
||||
quantity=1,
|
||||
ship_date="2020-02-02T20:20:20.000222Z",
|
||||
status="placed",
|
||||
complete=False,
|
||||
)
|
||||
try:
|
||||
# Place an order for a pet
|
||||
api_response = api_instance.place_order(
|
||||
body=body,
|
||||
)
|
||||
pprint(api_response)
|
||||
except petstore_api.ApiException as e:
|
||||
print("Exception when calling StoreApi->place_order: %s\n" % e)
|
||||
```
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
body | typing.Union[SchemaForRequestBodyApplicationJson] | required |
|
||||
content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body
|
||||
accept_content_types | typing.Tuple[str] | default is ('application/xml', 'application/json', ) | Tells the server the content type(s) that are accepted by the client
|
||||
stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file
|
||||
timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client
|
||||
skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned
|
||||
|
||||
### body
|
||||
|
||||
# SchemaForRequestBodyApplicationJson
|
||||
Type | Description | Notes
|
||||
------------- | ------------- | -------------
|
||||
[**Order**](../../models/Order.md) | |
|
||||
|
||||
|
||||
### Return Types, Responses
|
||||
|
||||
Code | Class | Description
|
||||
------------- | ------------- | -------------
|
||||
n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned
|
||||
200 | [ApiResponseFor200](#place_order.ApiResponseFor200) | successful operation
|
||||
400 | [ApiResponseFor400](#place_order.ApiResponseFor400) | Invalid Order
|
||||
|
||||
#### place_order.ApiResponseFor200
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
response | urllib3.HTTPResponse | Raw response |
|
||||
body | typing.Union[SchemaFor200ResponseBodyApplicationXml, SchemaFor200ResponseBodyApplicationJson, ] | |
|
||||
headers | Unset | headers were not defined |
|
||||
|
||||
# SchemaFor200ResponseBodyApplicationXml
|
||||
Type | Description | Notes
|
||||
------------- | ------------- | -------------
|
||||
[**Order**](../../models/Order.md) | |
|
||||
|
||||
|
||||
# SchemaFor200ResponseBodyApplicationJson
|
||||
Type | Description | Notes
|
||||
------------- | ------------- | -------------
|
||||
[**Order**](../../models/Order.md) | |
|
||||
|
||||
|
||||
#### place_order.ApiResponseFor400
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
response | urllib3.HTTPResponse | Raw response |
|
||||
body | Unset | body was not defined |
|
||||
headers | Unset | headers were not defined |
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
|
||||
|
||||
@@ -1,794 +0,0 @@
|
||||
<a id="__pageTop"></a>
|
||||
# petstore_api.apis.tags.user_api.UserApi
|
||||
|
||||
All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**create_user**](#create_user) | **post** /user | Create user
|
||||
[**create_users_with_array_input**](#create_users_with_array_input) | **post** /user/createWithArray | Creates list of users with given input array
|
||||
[**create_users_with_list_input**](#create_users_with_list_input) | **post** /user/createWithList | Creates list of users with given input array
|
||||
[**delete_user**](#delete_user) | **delete** /user/{username} | Delete user
|
||||
[**get_user_by_name**](#get_user_by_name) | **get** /user/{username} | Get user by user name
|
||||
[**login_user**](#login_user) | **get** /user/login | Logs user into the system
|
||||
[**logout_user**](#logout_user) | **get** /user/logout | Logs out current logged in user session
|
||||
[**update_user**](#update_user) | **put** /user/{username} | Updated user
|
||||
|
||||
# **create_user**
|
||||
<a id="create_user"></a>
|
||||
> create_user(user)
|
||||
|
||||
Create user
|
||||
|
||||
This can only be done by the logged in user.
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
import petstore_api
|
||||
from petstore_api.apis.tags import user_api
|
||||
from petstore_api.model.user import User
|
||||
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 = user_api.UserApi(api_client)
|
||||
|
||||
# example passing only required values which don't have defaults set
|
||||
body = User(
|
||||
id=1,
|
||||
username="username_example",
|
||||
first_name="first_name_example",
|
||||
last_name="last_name_example",
|
||||
email="email_example",
|
||||
password="password_example",
|
||||
phone="phone_example",
|
||||
user_status=1,
|
||||
object_with_no_declared_props=dict(),
|
||||
object_with_no_declared_props_nullable=dict(),
|
||||
any_type_prop=None,
|
||||
any_type_except_null_prop=None,
|
||||
any_type_prop_nullable=None,
|
||||
)
|
||||
try:
|
||||
# Create user
|
||||
api_response = api_instance.create_user(
|
||||
body=body,
|
||||
)
|
||||
except petstore_api.ApiException as e:
|
||||
print("Exception when calling UserApi->create_user: %s\n" % e)
|
||||
```
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
body | typing.Union[SchemaForRequestBodyApplicationJson] | required |
|
||||
content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body
|
||||
stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file
|
||||
timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client
|
||||
skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned
|
||||
|
||||
### body
|
||||
|
||||
# SchemaForRequestBodyApplicationJson
|
||||
Type | Description | Notes
|
||||
------------- | ------------- | -------------
|
||||
[**User**](../../models/User.md) | |
|
||||
|
||||
|
||||
### Return Types, Responses
|
||||
|
||||
Code | Class | Description
|
||||
------------- | ------------- | -------------
|
||||
n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned
|
||||
default | [ApiResponseForDefault](#create_user.ApiResponseForDefault) | successful operation
|
||||
|
||||
#### create_user.ApiResponseForDefault
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
response | urllib3.HTTPResponse | Raw response |
|
||||
body | Unset | body was not defined |
|
||||
headers | Unset | headers were not defined |
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
|
||||
|
||||
# **create_users_with_array_input**
|
||||
<a id="create_users_with_array_input"></a>
|
||||
> create_users_with_array_input(user)
|
||||
|
||||
Creates list of users with given input array
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
import petstore_api
|
||||
from petstore_api.apis.tags import user_api
|
||||
from petstore_api.model.user import User
|
||||
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 = user_api.UserApi(api_client)
|
||||
|
||||
# example passing only required values which don't have defaults set
|
||||
body = [
|
||||
User(
|
||||
id=1,
|
||||
username="username_example",
|
||||
first_name="first_name_example",
|
||||
last_name="last_name_example",
|
||||
email="email_example",
|
||||
password="password_example",
|
||||
phone="phone_example",
|
||||
user_status=1,
|
||||
object_with_no_declared_props=dict(),
|
||||
object_with_no_declared_props_nullable=dict(),
|
||||
any_type_prop=None,
|
||||
any_type_except_null_prop=None,
|
||||
any_type_prop_nullable=None,
|
||||
)
|
||||
]
|
||||
try:
|
||||
# Creates list of users with given input array
|
||||
api_response = api_instance.create_users_with_array_input(
|
||||
body=body,
|
||||
)
|
||||
except petstore_api.ApiException as e:
|
||||
print("Exception when calling UserApi->create_users_with_array_input: %s\n" % e)
|
||||
```
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
body | typing.Union[SchemaForRequestBodyApplicationJson] | required |
|
||||
content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body
|
||||
stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file
|
||||
timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client
|
||||
skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned
|
||||
|
||||
### body
|
||||
|
||||
# SchemaForRequestBodyApplicationJson
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
list, tuple, | tuple, | |
|
||||
|
||||
### Tuple Items
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
[**User**]({{complexTypePrefix}}User.md) | [**User**]({{complexTypePrefix}}User.md) | [**User**]({{complexTypePrefix}}User.md) | |
|
||||
|
||||
### Return Types, Responses
|
||||
|
||||
Code | Class | Description
|
||||
------------- | ------------- | -------------
|
||||
n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned
|
||||
default | [ApiResponseForDefault](#create_users_with_array_input.ApiResponseForDefault) | successful operation
|
||||
|
||||
#### create_users_with_array_input.ApiResponseForDefault
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
response | urllib3.HTTPResponse | Raw response |
|
||||
body | Unset | body was not defined |
|
||||
headers | Unset | headers were not defined |
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
|
||||
|
||||
# **create_users_with_list_input**
|
||||
<a id="create_users_with_list_input"></a>
|
||||
> create_users_with_list_input(user)
|
||||
|
||||
Creates list of users with given input array
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
import petstore_api
|
||||
from petstore_api.apis.tags import user_api
|
||||
from petstore_api.model.user import User
|
||||
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 = user_api.UserApi(api_client)
|
||||
|
||||
# example passing only required values which don't have defaults set
|
||||
body = [
|
||||
User(
|
||||
id=1,
|
||||
username="username_example",
|
||||
first_name="first_name_example",
|
||||
last_name="last_name_example",
|
||||
email="email_example",
|
||||
password="password_example",
|
||||
phone="phone_example",
|
||||
user_status=1,
|
||||
object_with_no_declared_props=dict(),
|
||||
object_with_no_declared_props_nullable=dict(),
|
||||
any_type_prop=None,
|
||||
any_type_except_null_prop=None,
|
||||
any_type_prop_nullable=None,
|
||||
)
|
||||
]
|
||||
try:
|
||||
# Creates list of users with given input array
|
||||
api_response = api_instance.create_users_with_list_input(
|
||||
body=body,
|
||||
)
|
||||
except petstore_api.ApiException as e:
|
||||
print("Exception when calling UserApi->create_users_with_list_input: %s\n" % e)
|
||||
```
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
body | typing.Union[SchemaForRequestBodyApplicationJson] | required |
|
||||
content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body
|
||||
stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file
|
||||
timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client
|
||||
skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned
|
||||
|
||||
### body
|
||||
|
||||
# SchemaForRequestBodyApplicationJson
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
list, tuple, | tuple, | |
|
||||
|
||||
### Tuple Items
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
[**User**]({{complexTypePrefix}}User.md) | [**User**]({{complexTypePrefix}}User.md) | [**User**]({{complexTypePrefix}}User.md) | |
|
||||
|
||||
### Return Types, Responses
|
||||
|
||||
Code | Class | Description
|
||||
------------- | ------------- | -------------
|
||||
n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned
|
||||
default | [ApiResponseForDefault](#create_users_with_list_input.ApiResponseForDefault) | successful operation
|
||||
|
||||
#### create_users_with_list_input.ApiResponseForDefault
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
response | urllib3.HTTPResponse | Raw response |
|
||||
body | Unset | body was not defined |
|
||||
headers | Unset | headers were not defined |
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
|
||||
|
||||
# **delete_user**
|
||||
<a id="delete_user"></a>
|
||||
> delete_user(username)
|
||||
|
||||
Delete user
|
||||
|
||||
This can only be done by the logged in user.
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
import petstore_api
|
||||
from petstore_api.apis.tags import user_api
|
||||
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 = user_api.UserApi(api_client)
|
||||
|
||||
# example passing only required values which don't have defaults set
|
||||
path_params = {
|
||||
'username': "username_example",
|
||||
}
|
||||
try:
|
||||
# Delete user
|
||||
api_response = api_instance.delete_user(
|
||||
path_params=path_params,
|
||||
)
|
||||
except petstore_api.ApiException as e:
|
||||
print("Exception when calling UserApi->delete_user: %s\n" % e)
|
||||
```
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
path_params | RequestPathParams | |
|
||||
stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file
|
||||
timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client
|
||||
skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned
|
||||
|
||||
### path_params
|
||||
#### RequestPathParams
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
username | UsernameSchema | |
|
||||
|
||||
# UsernameSchema
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
str, | str, | |
|
||||
|
||||
### Return Types, Responses
|
||||
|
||||
Code | Class | Description
|
||||
------------- | ------------- | -------------
|
||||
n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned
|
||||
200 | [ApiResponseFor200](#delete_user.ApiResponseFor200) | Success
|
||||
404 | [ApiResponseFor404](#delete_user.ApiResponseFor404) | User not found
|
||||
|
||||
#### delete_user.ApiResponseFor200
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
response | urllib3.HTTPResponse | Raw response |
|
||||
body | Unset | body was not defined |
|
||||
headers | Unset | headers were not defined |
|
||||
|
||||
#### delete_user.ApiResponseFor404
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
response | urllib3.HTTPResponse | Raw response |
|
||||
body | Unset | body was not defined |
|
||||
headers | Unset | headers were not defined |
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
|
||||
|
||||
# **get_user_by_name**
|
||||
<a id="get_user_by_name"></a>
|
||||
> User get_user_by_name(username)
|
||||
|
||||
Get user by user name
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
import petstore_api
|
||||
from petstore_api.apis.tags import user_api
|
||||
from petstore_api.model.user import User
|
||||
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 = user_api.UserApi(api_client)
|
||||
|
||||
# example passing only required values which don't have defaults set
|
||||
path_params = {
|
||||
'username': "username_example",
|
||||
}
|
||||
try:
|
||||
# Get user by user name
|
||||
api_response = api_instance.get_user_by_name(
|
||||
path_params=path_params,
|
||||
)
|
||||
pprint(api_response)
|
||||
except petstore_api.ApiException as e:
|
||||
print("Exception when calling UserApi->get_user_by_name: %s\n" % e)
|
||||
```
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
path_params | RequestPathParams | |
|
||||
accept_content_types | typing.Tuple[str] | default is ('application/xml', 'application/json', ) | Tells the server the content type(s) that are accepted by the client
|
||||
stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file
|
||||
timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client
|
||||
skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned
|
||||
|
||||
### path_params
|
||||
#### RequestPathParams
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
username | UsernameSchema | |
|
||||
|
||||
# UsernameSchema
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
str, | str, | |
|
||||
|
||||
### Return Types, Responses
|
||||
|
||||
Code | Class | Description
|
||||
------------- | ------------- | -------------
|
||||
n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned
|
||||
200 | [ApiResponseFor200](#get_user_by_name.ApiResponseFor200) | successful operation
|
||||
400 | [ApiResponseFor400](#get_user_by_name.ApiResponseFor400) | Invalid username supplied
|
||||
404 | [ApiResponseFor404](#get_user_by_name.ApiResponseFor404) | User not found
|
||||
|
||||
#### get_user_by_name.ApiResponseFor200
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
response | urllib3.HTTPResponse | Raw response |
|
||||
body | typing.Union[SchemaFor200ResponseBodyApplicationXml, SchemaFor200ResponseBodyApplicationJson, ] | |
|
||||
headers | Unset | headers were not defined |
|
||||
|
||||
# SchemaFor200ResponseBodyApplicationXml
|
||||
Type | Description | Notes
|
||||
------------- | ------------- | -------------
|
||||
[**User**](../../models/User.md) | |
|
||||
|
||||
|
||||
# SchemaFor200ResponseBodyApplicationJson
|
||||
Type | Description | Notes
|
||||
------------- | ------------- | -------------
|
||||
[**User**](../../models/User.md) | |
|
||||
|
||||
|
||||
#### get_user_by_name.ApiResponseFor400
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
response | urllib3.HTTPResponse | Raw response |
|
||||
body | Unset | body was not defined |
|
||||
headers | Unset | headers were not defined |
|
||||
|
||||
#### get_user_by_name.ApiResponseFor404
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
response | urllib3.HTTPResponse | Raw response |
|
||||
body | Unset | body was not defined |
|
||||
headers | Unset | headers were not defined |
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
|
||||
|
||||
# **login_user**
|
||||
<a id="login_user"></a>
|
||||
> str login_user(usernamepassword)
|
||||
|
||||
Logs user into the system
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
import petstore_api
|
||||
from petstore_api.apis.tags import user_api
|
||||
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 = user_api.UserApi(api_client)
|
||||
|
||||
# example passing only required values which don't have defaults set
|
||||
query_params = {
|
||||
'username': "username_example",
|
||||
'password': "password_example",
|
||||
}
|
||||
try:
|
||||
# Logs user into the system
|
||||
api_response = api_instance.login_user(
|
||||
query_params=query_params,
|
||||
)
|
||||
pprint(api_response)
|
||||
except petstore_api.ApiException as e:
|
||||
print("Exception when calling UserApi->login_user: %s\n" % e)
|
||||
```
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
query_params | RequestQueryParams | |
|
||||
accept_content_types | typing.Tuple[str] | default is ('application/xml', 'application/json', ) | Tells the server the content type(s) that are accepted by the client
|
||||
stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file
|
||||
timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client
|
||||
skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned
|
||||
|
||||
### query_params
|
||||
#### RequestQueryParams
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
username | UsernameSchema | |
|
||||
password | PasswordSchema | |
|
||||
|
||||
|
||||
# UsernameSchema
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
str, | str, | |
|
||||
|
||||
# PasswordSchema
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
str, | str, | |
|
||||
|
||||
### Return Types, Responses
|
||||
|
||||
Code | Class | Description
|
||||
------------- | ------------- | -------------
|
||||
n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned
|
||||
200 | [ApiResponseFor200](#login_user.ApiResponseFor200) | successful operation
|
||||
400 | [ApiResponseFor400](#login_user.ApiResponseFor400) | Invalid username/password supplied
|
||||
|
||||
#### login_user.ApiResponseFor200
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
response | urllib3.HTTPResponse | Raw response |
|
||||
body | typing.Union[SchemaFor200ResponseBodyApplicationXml, SchemaFor200ResponseBodyApplicationJson, ] | |
|
||||
headers | ResponseHeadersFor200 | |
|
||||
|
||||
# SchemaFor200ResponseBodyApplicationXml
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
str, | str, | |
|
||||
|
||||
# SchemaFor200ResponseBodyApplicationJson
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
str, | str, | |
|
||||
#### ResponseHeadersFor200
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
X-Rate-Limit | XRateLimitSchema | | optional
|
||||
X-Expires-After | XExpiresAfterSchema | | optional
|
||||
|
||||
# XRateLimitSchema
|
||||
|
||||
calls per hour allowed by the user
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
decimal.Decimal, int, | decimal.Decimal, | calls per hour allowed by the user | value must be a 32 bit integer
|
||||
|
||||
# XExpiresAfterSchema
|
||||
|
||||
date in UTC when token expires
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
str, datetime, | str, | date in UTC when token expires | value must conform to RFC-3339 date-time
|
||||
|
||||
|
||||
#### login_user.ApiResponseFor400
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
response | urllib3.HTTPResponse | Raw response |
|
||||
body | Unset | body was not defined |
|
||||
headers | Unset | headers were not defined |
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
|
||||
|
||||
# **logout_user**
|
||||
<a id="logout_user"></a>
|
||||
> logout_user()
|
||||
|
||||
Logs out current logged in user session
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
import petstore_api
|
||||
from petstore_api.apis.tags import user_api
|
||||
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 = user_api.UserApi(api_client)
|
||||
|
||||
# example, this endpoint has no required or optional parameters
|
||||
try:
|
||||
# Logs out current logged in user session
|
||||
api_response = api_instance.logout_user()
|
||||
except petstore_api.ApiException as e:
|
||||
print("Exception when calling UserApi->logout_user: %s\n" % e)
|
||||
```
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return Types, Responses
|
||||
|
||||
Code | Class | Description
|
||||
------------- | ------------- | -------------
|
||||
n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned
|
||||
default | [ApiResponseForDefault](#logout_user.ApiResponseForDefault) | successful operation
|
||||
|
||||
#### logout_user.ApiResponseForDefault
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
response | urllib3.HTTPResponse | Raw response |
|
||||
body | Unset | body was not defined |
|
||||
headers | Unset | headers were not defined |
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
|
||||
|
||||
# **update_user**
|
||||
<a id="update_user"></a>
|
||||
> update_user(usernameuser)
|
||||
|
||||
Updated user
|
||||
|
||||
This can only be done by the logged in user.
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
import petstore_api
|
||||
from petstore_api.apis.tags import user_api
|
||||
from petstore_api.model.user import User
|
||||
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 = user_api.UserApi(api_client)
|
||||
|
||||
# example passing only required values which don't have defaults set
|
||||
path_params = {
|
||||
'username': "username_example",
|
||||
}
|
||||
body = User(
|
||||
id=1,
|
||||
username="username_example",
|
||||
first_name="first_name_example",
|
||||
last_name="last_name_example",
|
||||
email="email_example",
|
||||
password="password_example",
|
||||
phone="phone_example",
|
||||
user_status=1,
|
||||
object_with_no_declared_props=dict(),
|
||||
object_with_no_declared_props_nullable=dict(),
|
||||
any_type_prop=None,
|
||||
any_type_except_null_prop=None,
|
||||
any_type_prop_nullable=None,
|
||||
)
|
||||
try:
|
||||
# Updated user
|
||||
api_response = api_instance.update_user(
|
||||
path_params=path_params,
|
||||
body=body,
|
||||
)
|
||||
except petstore_api.ApiException as e:
|
||||
print("Exception when calling UserApi->update_user: %s\n" % e)
|
||||
```
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
body | typing.Union[SchemaForRequestBodyApplicationJson] | required |
|
||||
path_params | RequestPathParams | |
|
||||
content_type | str | optional, default is 'application/json' | Selects the schema and serialization of the request body
|
||||
stream | bool | default is False | if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file
|
||||
timeout | typing.Optional[typing.Union[int, typing.Tuple]] | default is None | the timeout used by the rest client
|
||||
skip_deserialization | bool | default is False | when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned
|
||||
|
||||
### body
|
||||
|
||||
# SchemaForRequestBodyApplicationJson
|
||||
Type | Description | Notes
|
||||
------------- | ------------- | -------------
|
||||
[**User**](../../models/User.md) | |
|
||||
|
||||
|
||||
### path_params
|
||||
#### RequestPathParams
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
username | UsernameSchema | |
|
||||
|
||||
# UsernameSchema
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
str, | str, | |
|
||||
|
||||
### Return Types, Responses
|
||||
|
||||
Code | Class | Description
|
||||
------------- | ------------- | -------------
|
||||
n/a | api_client.ApiResponseWithoutDeserialization | When skip_deserialization is True this response is returned
|
||||
400 | [ApiResponseFor400](#update_user.ApiResponseFor400) | Invalid user supplied
|
||||
404 | [ApiResponseFor404](#update_user.ApiResponseFor404) | User not found
|
||||
|
||||
#### update_user.ApiResponseFor400
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
response | urllib3.HTTPResponse | Raw response |
|
||||
body | Unset | body was not defined |
|
||||
headers | Unset | headers were not defined |
|
||||
|
||||
#### update_user.ApiResponseFor404
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
response | urllib3.HTTPResponse | Raw response |
|
||||
body | Unset | body was not defined |
|
||||
headers | Unset | headers were not defined |
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
[[Back to top]](#__pageTop) [[Back to API list]](../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../README.md#documentation-for-models) [[Back to README]](../../../README.md)
|
||||
|
||||
@@ -1,109 +0,0 @@
|
||||
# petstore_api.model.additional_properties_class.AdditionalPropertiesClass
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**[map_property](#map_property)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional]
|
||||
**[map_of_map_property](#map_of_map_property)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional]
|
||||
**anytype_1** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | [optional]
|
||||
**[map_with_undeclared_properties_anytype_1](#map_with_undeclared_properties_anytype_1)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional]
|
||||
**[map_with_undeclared_properties_anytype_2](#map_with_undeclared_properties_anytype_2)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional]
|
||||
**[map_with_undeclared_properties_anytype_3](#map_with_undeclared_properties_anytype_3)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional]
|
||||
**[empty_map](#empty_map)** | dict, frozendict.frozendict, | frozendict.frozendict, | an object with no declared properties and no undeclared properties, hence it's an empty map. | [optional]
|
||||
**[map_with_undeclared_properties_string](#map_with_undeclared_properties_string)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional]
|
||||
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
# map_property
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**any_string_name** | str, | str, | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
# map_of_map_property
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**[any_string_name](#any_string_name)** | dict, frozendict.frozendict, | frozendict.frozendict, | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
# any_string_name
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**any_string_name** | str, | str, | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
# map_with_undeclared_properties_anytype_1
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
# map_with_undeclared_properties_anytype_2
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
# map_with_undeclared_properties_anytype_3
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
# empty_map
|
||||
|
||||
an object with no declared properties and no undeclared properties, hence it's an empty map.
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | an object with no declared properties and no undeclared properties, hence it's an empty map. |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
|
||||
# map_with_undeclared_properties_string
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**any_string_name** | str, | str, | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,53 +0,0 @@
|
||||
# petstore_api.model.additional_properties_validator.AdditionalPropertiesValidator
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Composed Schemas (allOf/anyOf/oneOf/not)
|
||||
#### allOf
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
[all_of_0](#all_of_0) | dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
[all_of_1](#all_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
[all_of_2](#all_of_2) | dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
# all_of_0
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
# all_of_1
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
# all_of_2
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,26 +0,0 @@
|
||||
# petstore_api.model.additional_properties_with_array_of_enums.AdditionalPropertiesWithArrayOfEnums
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**[any_string_name](#any_string_name)** | list, tuple, | tuple, | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
# any_string_name
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
list, tuple, | tuple, | |
|
||||
|
||||
### Tuple Items
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
[**EnumClass**](EnumClass.md) | [**EnumClass**](EnumClass.md) | [**EnumClass**](EnumClass.md) | |
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,14 +0,0 @@
|
||||
# petstore_api.model.address.Address
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**any_string_name** | decimal.Decimal, int, | decimal.Decimal, | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,16 +0,0 @@
|
||||
# petstore_api.model.animal.Animal
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**className** | str, | str, | |
|
||||
**color** | str, | str, | | [optional] if omitted the server will use the default value of "red"
|
||||
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,14 +0,0 @@
|
||||
# petstore_api.model.animal_farm.AnimalFarm
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
list, tuple, | tuple, | |
|
||||
|
||||
### Tuple Items
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
[**Animal**](Animal.md) | [**Animal**](Animal.md) | [**Animal**](Animal.md) | |
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,23 +0,0 @@
|
||||
# petstore_api.model.any_type_and_format.AnyTypeAndFormat
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**uuid** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | [optional] value must be a uuid
|
||||
**date** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | [optional] value must conform to RFC-3339 full-date YYYY-MM-DD
|
||||
**date-time** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | [optional] value must conform to RFC-3339 date-time
|
||||
**number** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | [optional] value must be numeric and storable in decimal.Decimal
|
||||
**binary** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | [optional]
|
||||
**int32** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | [optional] value must be a 32 bit integer
|
||||
**int64** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | [optional] value must be a 64 bit integer
|
||||
**double** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | [optional] value must be a 64 bit float
|
||||
**float** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | | [optional] value must be a 32 bit float
|
||||
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,22 +0,0 @@
|
||||
# petstore_api.model.any_type_not_string.AnyTypeNotString
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | |
|
||||
|
||||
### Composed Schemas (allOf/anyOf/oneOf/not)
|
||||
#### not
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
[not_schema](#not_schema) | str, | str, | |
|
||||
|
||||
# not_schema
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
str, | str, | |
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,17 +0,0 @@
|
||||
# petstore_api.model.api_response.ApiResponse
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**code** | decimal.Decimal, int, | decimal.Decimal, | | [optional] value must be a 32 bit integer
|
||||
**type** | str, | str, | | [optional]
|
||||
**message** | str, | str, | | [optional]
|
||||
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,16 +0,0 @@
|
||||
# petstore_api.model.apple.Apple
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**cultivar** | str, | str, | |
|
||||
**origin** | str, | str, | | [optional]
|
||||
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,15 +0,0 @@
|
||||
# petstore_api.model.apple_req.AppleReq
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**cultivar** | str, | str, | |
|
||||
**mealy** | bool, | BoolClass, | | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,14 +0,0 @@
|
||||
# petstore_api.model.array_holding_any_type.ArrayHoldingAnyType
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
list, tuple, | tuple, | |
|
||||
|
||||
### Tuple Items
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
items | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | any type can be stored here |
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,39 +0,0 @@
|
||||
# petstore_api.model.array_of_array_of_number_only.ArrayOfArrayOfNumberOnly
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**[ArrayArrayNumber](#ArrayArrayNumber)** | list, tuple, | tuple, | | [optional]
|
||||
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
# ArrayArrayNumber
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
list, tuple, | tuple, | |
|
||||
|
||||
### Tuple Items
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
[items](#items) | list, tuple, | tuple, | |
|
||||
|
||||
# items
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
list, tuple, | tuple, | |
|
||||
|
||||
### Tuple Items
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
items | decimal.Decimal, int, float, | decimal.Decimal, | |
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,14 +0,0 @@
|
||||
# petstore_api.model.array_of_enums.ArrayOfEnums
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
list, tuple, | tuple, | |
|
||||
|
||||
### Tuple Items
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
[**StringEnum**](StringEnum.md) | [**StringEnum**](StringEnum.md) | [**StringEnum**](StringEnum.md) | |
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,27 +0,0 @@
|
||||
# petstore_api.model.array_of_number_only.ArrayOfNumberOnly
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**[ArrayNumber](#ArrayNumber)** | list, tuple, | tuple, | | [optional]
|
||||
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
# ArrayNumber
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
list, tuple, | tuple, | |
|
||||
|
||||
### Tuple Items
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
items | decimal.Decimal, int, float, | decimal.Decimal, | |
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,77 +0,0 @@
|
||||
# petstore_api.model.array_test.ArrayTest
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**[array_of_string](#array_of_string)** | list, tuple, | tuple, | | [optional]
|
||||
**[array_array_of_integer](#array_array_of_integer)** | list, tuple, | tuple, | | [optional]
|
||||
**[array_array_of_model](#array_array_of_model)** | list, tuple, | tuple, | | [optional]
|
||||
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
# array_of_string
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
list, tuple, | tuple, | |
|
||||
|
||||
### Tuple Items
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
items | str, | str, | |
|
||||
|
||||
# array_array_of_integer
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
list, tuple, | tuple, | |
|
||||
|
||||
### Tuple Items
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
[items](#items) | list, tuple, | tuple, | |
|
||||
|
||||
# items
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
list, tuple, | tuple, | |
|
||||
|
||||
### Tuple Items
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
items | decimal.Decimal, int, | decimal.Decimal, | | value must be a 64 bit integer
|
||||
|
||||
# array_array_of_model
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
list, tuple, | tuple, | |
|
||||
|
||||
### Tuple Items
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
[items](#items) | list, tuple, | tuple, | |
|
||||
|
||||
# items
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
list, tuple, | tuple, | |
|
||||
|
||||
### Tuple Items
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
[**ReadOnlyFirst**](ReadOnlyFirst.md) | [**ReadOnlyFirst**](ReadOnlyFirst.md) | [**ReadOnlyFirst**](ReadOnlyFirst.md) | |
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,14 +0,0 @@
|
||||
# petstore_api.model.array_with_validations_in_items.ArrayWithValidationsInItems
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
list, tuple, | tuple, | |
|
||||
|
||||
### Tuple Items
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
items | decimal.Decimal, int, | decimal.Decimal, | | value must be a 64 bit integer
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,15 +0,0 @@
|
||||
# petstore_api.model.banana.Banana
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**lengthCm** | decimal.Decimal, int, float, | decimal.Decimal, | |
|
||||
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,15 +0,0 @@
|
||||
# petstore_api.model.banana_req.BananaReq
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**lengthCm** | decimal.Decimal, int, float, | decimal.Decimal, | |
|
||||
**sweet** | bool, | BoolClass, | | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,9 +0,0 @@
|
||||
# petstore_api.model.bar.Bar
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
str, | str, | | if omitted the server will use the default value of "bar"
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,15 +0,0 @@
|
||||
# petstore_api.model.basque_pig.BasquePig
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**className** | str, | str, | | must be one of ["BasquePig", ]
|
||||
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,9 +0,0 @@
|
||||
# petstore_api.model.boolean.Boolean
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
bool, | BoolClass, | |
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,9 +0,0 @@
|
||||
# petstore_api.model.boolean_enum.BooleanEnum
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
bool, | BoolClass, | | must be one of [True, ]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,20 +0,0 @@
|
||||
# petstore_api.model.capitalization.Capitalization
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**smallCamel** | str, | str, | | [optional]
|
||||
**CapitalCamel** | str, | str, | | [optional]
|
||||
**small_Snake** | str, | str, | | [optional]
|
||||
**Capital_Snake** | str, | str, | | [optional]
|
||||
**SCA_ETH_Flow_Points** | str, | str, | | [optional]
|
||||
**ATT_NAME** | str, | str, | Name of the pet | [optional]
|
||||
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,29 +0,0 @@
|
||||
# petstore_api.model.cat.Cat
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | |
|
||||
|
||||
### Composed Schemas (allOf/anyOf/oneOf/not)
|
||||
#### allOf
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
[Animal](Animal.md) | [**Animal**](Animal.md) | [**Animal**](Animal.md) | |
|
||||
[all_of_1](#all_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
# all_of_1
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**declawed** | bool, | BoolClass, | | [optional]
|
||||
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,16 +0,0 @@
|
||||
# petstore_api.model.category.Category
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**name** | str, | str, | | if omitted the server will use the default value of "default-name"
|
||||
**id** | decimal.Decimal, int, | decimal.Decimal, | | [optional] value must be a 64 bit integer
|
||||
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,29 +0,0 @@
|
||||
# petstore_api.model.child_cat.ChildCat
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | |
|
||||
|
||||
### Composed Schemas (allOf/anyOf/oneOf/not)
|
||||
#### allOf
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
[ParentPet](ParentPet.md) | [**ParentPet**](ParentPet.md) | [**ParentPet**](ParentPet.md) | |
|
||||
[all_of_1](#all_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
# all_of_1
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**name** | str, | str, | | [optional]
|
||||
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,17 +0,0 @@
|
||||
# petstore_api.model.class_model.ClassModel
|
||||
|
||||
Model for testing model with \"_class\" property
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | Model for testing model with \"_class\" property |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**_class** | str, | str, | | [optional]
|
||||
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,15 +0,0 @@
|
||||
# petstore_api.model.client.Client
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**client** | str, | str, | | [optional]
|
||||
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,29 +0,0 @@
|
||||
# petstore_api.model.complex_quadrilateral.ComplexQuadrilateral
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | |
|
||||
|
||||
### Composed Schemas (allOf/anyOf/oneOf/not)
|
||||
#### allOf
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
[QuadrilateralInterface](QuadrilateralInterface.md) | [**QuadrilateralInterface**](QuadrilateralInterface.md) | [**QuadrilateralInterface**](QuadrilateralInterface.md) | |
|
||||
[all_of_1](#all_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
# all_of_1
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**quadrilateralType** | str, | str, | | [optional] must be one of ["ComplexQuadrilateral", ]
|
||||
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,147 +0,0 @@
|
||||
# petstore_api.model.composed_any_of_different_types_no_validations.ComposedAnyOfDifferentTypesNoValidations
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | |
|
||||
|
||||
### Composed Schemas (allOf/anyOf/oneOf/not)
|
||||
#### anyOf
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
[any_of_0](#any_of_0) | dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
[any_of_1](#any_of_1) | str, date, | str, | | value must conform to RFC-3339 full-date YYYY-MM-DD
|
||||
[any_of_2](#any_of_2) | str, datetime, | str, | | value must conform to RFC-3339 date-time
|
||||
[any_of_3](#any_of_3) | bytes, io.FileIO, io.BufferedReader, | bytes, FileIO, | |
|
||||
[any_of_4](#any_of_4) | str, | str, | |
|
||||
[any_of_5](#any_of_5) | str, | str, | |
|
||||
[any_of_6](#any_of_6) | dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
[any_of_7](#any_of_7) | bool, | BoolClass, | |
|
||||
[any_of_8](#any_of_8) | None, | NoneClass, | |
|
||||
[any_of_9](#any_of_9) | list, tuple, | tuple, | |
|
||||
[any_of_10](#any_of_10) | decimal.Decimal, int, float, | decimal.Decimal, | |
|
||||
[any_of_11](#any_of_11) | decimal.Decimal, int, float, | decimal.Decimal, | | value must be a 32 bit float
|
||||
[any_of_12](#any_of_12) | decimal.Decimal, int, float, | decimal.Decimal, | | value must be a 64 bit float
|
||||
[any_of_13](#any_of_13) | decimal.Decimal, int, | decimal.Decimal, | |
|
||||
[any_of_14](#any_of_14) | decimal.Decimal, int, | decimal.Decimal, | | value must be a 32 bit integer
|
||||
[any_of_15](#any_of_15) | decimal.Decimal, int, | decimal.Decimal, | | value must be a 64 bit integer
|
||||
|
||||
# any_of_0
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
# any_of_1
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
str, date, | str, | | value must conform to RFC-3339 full-date YYYY-MM-DD
|
||||
|
||||
# any_of_2
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
str, datetime, | str, | | value must conform to RFC-3339 date-time
|
||||
|
||||
# any_of_3
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
bytes, io.FileIO, io.BufferedReader, | bytes, FileIO, | |
|
||||
|
||||
# any_of_4
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
str, | str, | |
|
||||
|
||||
# any_of_5
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
str, | str, | |
|
||||
|
||||
# any_of_6
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
# any_of_7
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
bool, | BoolClass, | |
|
||||
|
||||
# any_of_8
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
None, | NoneClass, | |
|
||||
|
||||
# any_of_9
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
list, tuple, | tuple, | |
|
||||
|
||||
### Tuple Items
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
items | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | |
|
||||
|
||||
# any_of_10
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
decimal.Decimal, int, float, | decimal.Decimal, | |
|
||||
|
||||
# any_of_11
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
decimal.Decimal, int, float, | decimal.Decimal, | | value must be a 32 bit float
|
||||
|
||||
# any_of_12
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
decimal.Decimal, int, float, | decimal.Decimal, | | value must be a 64 bit float
|
||||
|
||||
# any_of_13
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
decimal.Decimal, int, | decimal.Decimal, | |
|
||||
|
||||
# any_of_14
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
decimal.Decimal, int, | decimal.Decimal, | | value must be a 32 bit integer
|
||||
|
||||
# any_of_15
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
decimal.Decimal, int, | decimal.Decimal, | | value must be a 64 bit integer
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,14 +0,0 @@
|
||||
# petstore_api.model.composed_array.ComposedArray
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
list, tuple, | tuple, | |
|
||||
|
||||
### Tuple Items
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
items | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | |
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,22 +0,0 @@
|
||||
# petstore_api.model.composed_bool.ComposedBool
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
bool, | BoolClass, | |
|
||||
|
||||
### Composed Schemas (allOf/anyOf/oneOf/not)
|
||||
#### allOf
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
[all_of_0](#all_of_0) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | |
|
||||
|
||||
# all_of_0
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | |
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,22 +0,0 @@
|
||||
# petstore_api.model.composed_none.ComposedNone
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
None, | NoneClass, | |
|
||||
|
||||
### Composed Schemas (allOf/anyOf/oneOf/not)
|
||||
#### allOf
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
[all_of_0](#all_of_0) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | |
|
||||
|
||||
# all_of_0
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | |
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,22 +0,0 @@
|
||||
# petstore_api.model.composed_number.ComposedNumber
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
decimal.Decimal, int, float, | decimal.Decimal, | |
|
||||
|
||||
### Composed Schemas (allOf/anyOf/oneOf/not)
|
||||
#### allOf
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
[all_of_0](#all_of_0) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | |
|
||||
|
||||
# all_of_0
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | |
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,22 +0,0 @@
|
||||
# petstore_api.model.composed_object.ComposedObject
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Composed Schemas (allOf/anyOf/oneOf/not)
|
||||
#### allOf
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
[all_of_0](#all_of_0) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | |
|
||||
|
||||
# all_of_0
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | |
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,63 +0,0 @@
|
||||
# petstore_api.model.composed_one_of_different_types.ComposedOneOfDifferentTypes
|
||||
|
||||
this is a model that allows payloads of type object or number
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | this is a model that allows payloads of type object or number |
|
||||
|
||||
### Composed Schemas (allOf/anyOf/oneOf/not)
|
||||
#### oneOf
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
[NumberWithValidations](NumberWithValidations.md) | [**NumberWithValidations**](NumberWithValidations.md) | [**NumberWithValidations**](NumberWithValidations.md) | |
|
||||
[Animal](Animal.md) | [**Animal**](Animal.md) | [**Animal**](Animal.md) | |
|
||||
[one_of_2](#one_of_2) | None, | NoneClass, | |
|
||||
[one_of_3](#one_of_3) | str, date, | str, | | value must conform to RFC-3339 full-date YYYY-MM-DD
|
||||
[one_of_4](#one_of_4) | dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
[one_of_5](#one_of_5) | list, tuple, | tuple, | |
|
||||
[one_of_6](#one_of_6) | str, datetime, | str, | | value must conform to RFC-3339 date-time
|
||||
|
||||
# one_of_2
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
None, | NoneClass, | |
|
||||
|
||||
# one_of_3
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
str, date, | str, | | value must conform to RFC-3339 full-date YYYY-MM-DD
|
||||
|
||||
# one_of_4
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
# one_of_5
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
list, tuple, | tuple, | |
|
||||
|
||||
### Tuple Items
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
items | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | |
|
||||
|
||||
# one_of_6
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
str, datetime, | str, | | value must conform to RFC-3339 date-time
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,22 +0,0 @@
|
||||
# petstore_api.model.composed_string.ComposedString
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
str, | str, | |
|
||||
|
||||
### Composed Schemas (allOf/anyOf/oneOf/not)
|
||||
#### allOf
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
[all_of_0](#all_of_0) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | |
|
||||
|
||||
# all_of_0
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | |
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,9 +0,0 @@
|
||||
# petstore_api.model.currency.Currency
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
str, | str, | | must be one of ["eur", "usd", ]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,15 +0,0 @@
|
||||
# petstore_api.model.danish_pig.DanishPig
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**className** | str, | str, | | must be one of ["DanishPig", ]
|
||||
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,9 +0,0 @@
|
||||
# petstore_api.model.date_time_test.DateTimeTest
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
str, datetime, | str, | | if omitted the server will use the default value of 2010-01-01T10:10:10.000111+01:00value must conform to RFC-3339 date-time
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,9 +0,0 @@
|
||||
# petstore_api.model.date_time_with_validations.DateTimeWithValidations
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
str, datetime, | str, | | value must conform to RFC-3339 date-time
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,9 +0,0 @@
|
||||
# petstore_api.model.date_with_validations.DateWithValidations
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
str, date, | str, | | value must conform to RFC-3339 full-date YYYY-MM-DD
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,9 +0,0 @@
|
||||
# petstore_api.model.decimal_payload.DecimalPayload
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
str, | str, | | value must be numeric and storable in decimal.Decimal
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,29 +0,0 @@
|
||||
# petstore_api.model.dog.Dog
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | |
|
||||
|
||||
### Composed Schemas (allOf/anyOf/oneOf/not)
|
||||
#### allOf
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
[Animal](Animal.md) | [**Animal**](Animal.md) | [**Animal**](Animal.md) | |
|
||||
[all_of_1](#all_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
# all_of_1
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**breed** | str, | str, | | [optional]
|
||||
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,30 +0,0 @@
|
||||
# petstore_api.model.drawing.Drawing
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**mainShape** | [**Shape**](Shape.md) | [**Shape**](Shape.md) | | [optional]
|
||||
**shapeOrNull** | [**ShapeOrNull**](ShapeOrNull.md) | [**ShapeOrNull**](ShapeOrNull.md) | | [optional]
|
||||
**nullableShape** | [**NullableShape**](NullableShape.md) | [**NullableShape**](NullableShape.md) | | [optional]
|
||||
**[shapes](#shapes)** | list, tuple, | tuple, | | [optional]
|
||||
**any_string_name** | [**Fruit**](Fruit.md) | [**Fruit**](Fruit.md) | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
# shapes
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
list, tuple, | tuple, | |
|
||||
|
||||
### Tuple Items
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
[**Shape**](Shape.md) | [**Shape**](Shape.md) | [**Shape**](Shape.md) | |
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,28 +0,0 @@
|
||||
# petstore_api.model.enum_arrays.EnumArrays
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**just_symbol** | str, | str, | | [optional] must be one of [">=", "$", ]
|
||||
**[array_enum](#array_enum)** | list, tuple, | tuple, | | [optional]
|
||||
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
# array_enum
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
list, tuple, | tuple, | |
|
||||
|
||||
### Tuple Items
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
items | str, | str, | | must be one of ["fish", "crab", ]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,9 +0,0 @@
|
||||
# petstore_api.model.enum_class.EnumClass
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
str, | str, | | must be one of ["_abc", "-efg", "(xyz)", "COUNT_1M", "COUNT_50M", ] if omitted the server will use the default value of "-efg"
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,23 +0,0 @@
|
||||
# petstore_api.model.enum_test.EnumTest
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**enum_string_required** | str, | str, | | must be one of ["UPPER", "lower", "", ]
|
||||
**enum_string** | str, | str, | | [optional] must be one of ["UPPER", "lower", "", ]
|
||||
**enum_integer** | decimal.Decimal, int, | decimal.Decimal, | | [optional] must be one of [1, -1, ] value must be a 32 bit integer
|
||||
**enum_number** | decimal.Decimal, int, float, | decimal.Decimal, | | [optional] must be one of [1.1, -1.2, ] value must be a 64 bit float
|
||||
**stringEnum** | [**StringEnum**](StringEnum.md) | [**StringEnum**](StringEnum.md) | | [optional]
|
||||
**IntegerEnum** | [**IntegerEnum**](IntegerEnum.md) | [**IntegerEnum**](IntegerEnum.md) | | [optional]
|
||||
**StringEnumWithDefaultValue** | [**StringEnumWithDefaultValue**](StringEnumWithDefaultValue.md) | [**StringEnumWithDefaultValue**](StringEnumWithDefaultValue.md) | | [optional]
|
||||
**IntegerEnumWithDefaultValue** | [**IntegerEnumWithDefaultValue**](IntegerEnumWithDefaultValue.md) | [**IntegerEnumWithDefaultValue**](IntegerEnumWithDefaultValue.md) | | [optional]
|
||||
**IntegerEnumOneValue** | [**IntegerEnumOneValue**](IntegerEnumOneValue.md) | [**IntegerEnumOneValue**](IntegerEnumOneValue.md) | | [optional]
|
||||
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,29 +0,0 @@
|
||||
# petstore_api.model.equilateral_triangle.EquilateralTriangle
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | |
|
||||
|
||||
### Composed Schemas (allOf/anyOf/oneOf/not)
|
||||
#### allOf
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
[TriangleInterface](TriangleInterface.md) | [**TriangleInterface**](TriangleInterface.md) | [**TriangleInterface**](TriangleInterface.md) | |
|
||||
[all_of_1](#all_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
# all_of_1
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**triangleType** | str, | str, | | [optional] must be one of ["EquilateralTriangle", ]
|
||||
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,17 +0,0 @@
|
||||
# petstore_api.model.file.File
|
||||
|
||||
Must be named `File` for test.
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | Must be named `File` for test. |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**sourceURI** | str, | str, | Test capitalization | [optional]
|
||||
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,28 +0,0 @@
|
||||
# petstore_api.model.file_schema_test_class.FileSchemaTestClass
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**file** | [**File**](File.md) | [**File**](File.md) | | [optional]
|
||||
**[files](#files)** | list, tuple, | tuple, | | [optional]
|
||||
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
# files
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
list, tuple, | tuple, | |
|
||||
|
||||
### Tuple Items
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
[**File**](File.md) | [**File**](File.md) | [**File**](File.md) | |
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,15 +0,0 @@
|
||||
# petstore_api.model.foo.Foo
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**bar** | str, | str, | | [optional] if omitted the server will use the default value of "bar"
|
||||
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,47 +0,0 @@
|
||||
# petstore_api.model.format_test.FormatTest
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**date** | str, date, | str, | | value must conform to RFC-3339 full-date YYYY-MM-DD
|
||||
**number** | decimal.Decimal, int, float, | decimal.Decimal, | |
|
||||
**password** | str, | str, | |
|
||||
**byte** | str, | str, | |
|
||||
**integer** | decimal.Decimal, int, | decimal.Decimal, | | [optional]
|
||||
**int32** | decimal.Decimal, int, | decimal.Decimal, | | [optional] value must be a 32 bit integer
|
||||
**int32withValidations** | decimal.Decimal, int, | decimal.Decimal, | | [optional] value must be a 32 bit integer
|
||||
**int64** | decimal.Decimal, int, | decimal.Decimal, | | [optional] value must be a 64 bit integer
|
||||
**float** | decimal.Decimal, int, float, | decimal.Decimal, | this is a reserved python keyword | [optional] value must be a 32 bit float
|
||||
**float32** | decimal.Decimal, int, float, | decimal.Decimal, | | [optional] value must be a 32 bit float
|
||||
**double** | decimal.Decimal, int, float, | decimal.Decimal, | | [optional] value must be a 64 bit float
|
||||
**float64** | decimal.Decimal, int, float, | decimal.Decimal, | | [optional] value must be a 64 bit float
|
||||
**[arrayWithUniqueItems](#arrayWithUniqueItems)** | list, tuple, | tuple, | | [optional]
|
||||
**string** | str, | str, | | [optional]
|
||||
**binary** | bytes, io.FileIO, io.BufferedReader, | bytes, FileIO, | | [optional]
|
||||
**dateTime** | str, datetime, | str, | | [optional] value must conform to RFC-3339 date-time
|
||||
**uuid** | str, uuid.UUID, | str, | | [optional] value must be a uuid
|
||||
**uuidNoExample** | str, uuid.UUID, | str, | | [optional] value must be a uuid
|
||||
**pattern_with_digits** | str, | str, | A string that is a 10 digit number. Can have leading zeros. | [optional]
|
||||
**pattern_with_digits_and_delimiter** | str, | str, | A string starting with 'image_' (case insensitive) and one to three digits following i.e. Image_01. | [optional]
|
||||
**noneProp** | None, | NoneClass, | | [optional]
|
||||
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
# arrayWithUniqueItems
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
list, tuple, | tuple, | |
|
||||
|
||||
### Tuple Items
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
items | decimal.Decimal, int, float, | decimal.Decimal, | |
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,16 +0,0 @@
|
||||
# petstore_api.model.from_schema.FromSchema
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**data** | str, | str, | | [optional]
|
||||
**id** | decimal.Decimal, int, | decimal.Decimal, | | [optional]
|
||||
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,22 +0,0 @@
|
||||
# petstore_api.model.fruit.Fruit
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**color** | str, | str, | | [optional]
|
||||
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
### Composed Schemas (allOf/anyOf/oneOf/not)
|
||||
#### oneOf
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
[Apple](Apple.md) | [**Apple**](Apple.md) | [**Apple**](Apple.md) | |
|
||||
[Banana](Banana.md) | [**Banana**](Banana.md) | [**Banana**](Banana.md) | |
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,24 +0,0 @@
|
||||
# petstore_api.model.fruit_req.FruitReq
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | |
|
||||
|
||||
### Composed Schemas (allOf/anyOf/oneOf/not)
|
||||
#### oneOf
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
[one_of_0](#one_of_0) | None, | NoneClass, | |
|
||||
[AppleReq](AppleReq.md) | [**AppleReq**](AppleReq.md) | [**AppleReq**](AppleReq.md) | |
|
||||
[BananaReq](BananaReq.md) | [**BananaReq**](BananaReq.md) | [**BananaReq**](BananaReq.md) | |
|
||||
|
||||
# one_of_0
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
None, | NoneClass, | |
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,22 +0,0 @@
|
||||
# petstore_api.model.gm_fruit.GmFruit
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**color** | str, | str, | | [optional]
|
||||
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
### Composed Schemas (allOf/anyOf/oneOf/not)
|
||||
#### anyOf
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
[Apple](Apple.md) | [**Apple**](Apple.md) | [**Apple**](Apple.md) | |
|
||||
[Banana](Banana.md) | [**Banana**](Banana.md) | [**Banana**](Banana.md) | |
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,15 +0,0 @@
|
||||
# petstore_api.model.grandparent_animal.GrandparentAnimal
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**pet_type** | str, | str, | |
|
||||
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,16 +0,0 @@
|
||||
# petstore_api.model.has_only_read_only.HasOnlyReadOnly
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**bar** | str, | str, | | [optional]
|
||||
**foo** | str, | str, | | [optional]
|
||||
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,17 +0,0 @@
|
||||
# petstore_api.model.health_check_result.HealthCheckResult
|
||||
|
||||
Just a string to inform instance is up and running. Make it nullable in hope to get it as pointer in generated model.
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | Just a string to inform instance is up and running. Make it nullable in hope to get it as pointer in generated model. |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**NullableMessage** | None, str, | NoneClass, str, | | [optional]
|
||||
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,9 +0,0 @@
|
||||
# petstore_api.model.integer_enum.IntegerEnum
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
decimal.Decimal, int, | decimal.Decimal, | | must be one of [0, 1, 2, ]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,9 +0,0 @@
|
||||
# petstore_api.model.integer_enum_big.IntegerEnumBig
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
decimal.Decimal, int, | decimal.Decimal, | | must be one of [10, 11, 12, ]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,9 +0,0 @@
|
||||
# petstore_api.model.integer_enum_one_value.IntegerEnumOneValue
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
decimal.Decimal, int, | decimal.Decimal, | | must be one of [0, ]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,9 +0,0 @@
|
||||
# petstore_api.model.integer_enum_with_default_value.IntegerEnumWithDefaultValue
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
decimal.Decimal, int, | decimal.Decimal, | | must be one of [0, 1, 2, ] if omitted the server will use the default value of 0
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,9 +0,0 @@
|
||||
# petstore_api.model.integer_max10.IntegerMax10
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
decimal.Decimal, int, | decimal.Decimal, | | value must be a 64 bit integer
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,9 +0,0 @@
|
||||
# petstore_api.model.integer_min15.IntegerMin15
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
decimal.Decimal, int, | decimal.Decimal, | | value must be a 64 bit integer
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,29 +0,0 @@
|
||||
# petstore_api.model.isosceles_triangle.IsoscelesTriangle
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | |
|
||||
|
||||
### Composed Schemas (allOf/anyOf/oneOf/not)
|
||||
#### allOf
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
[TriangleInterface](TriangleInterface.md) | [**TriangleInterface**](TriangleInterface.md) | [**TriangleInterface**](TriangleInterface.md) | |
|
||||
[all_of_1](#all_of_1) | dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
# all_of_1
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**triangleType** | str, | str, | | [optional] must be one of ["IsoscelesTriangle", ]
|
||||
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,29 +0,0 @@
|
||||
# petstore_api.model.json_patch_request.JSONPatchRequest
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
list, tuple, | tuple, | |
|
||||
|
||||
### Tuple Items
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
[items](#items) | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | |
|
||||
|
||||
# items
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | |
|
||||
|
||||
### Composed Schemas (allOf/anyOf/oneOf/not)
|
||||
#### oneOf
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
[JSONPatchRequestAddReplaceTest](JSONPatchRequestAddReplaceTest.md) | [**JSONPatchRequestAddReplaceTest**](JSONPatchRequestAddReplaceTest.md) | [**JSONPatchRequestAddReplaceTest**](JSONPatchRequestAddReplaceTest.md) | |
|
||||
[JSONPatchRequestRemove](JSONPatchRequestRemove.md) | [**JSONPatchRequestRemove**](JSONPatchRequestRemove.md) | [**JSONPatchRequestRemove**](JSONPatchRequestRemove.md) | |
|
||||
[JSONPatchRequestMoveCopy](JSONPatchRequestMoveCopy.md) | [**JSONPatchRequestMoveCopy**](JSONPatchRequestMoveCopy.md) | [**JSONPatchRequestMoveCopy**](JSONPatchRequestMoveCopy.md) | |
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,16 +0,0 @@
|
||||
# petstore_api.model.json_patch_request_add_replace_test.JSONPatchRequestAddReplaceTest
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**op** | str, | str, | The operation to perform. | must be one of ["add", "replace", "test", ]
|
||||
**path** | str, | str, | A JSON Pointer path. |
|
||||
**value** | dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | The value to add, replace or test. |
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,16 +0,0 @@
|
||||
# petstore_api.model.json_patch_request_move_copy.JSONPatchRequestMoveCopy
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**op** | str, | str, | The operation to perform. | must be one of ["move", "copy", ]
|
||||
**path** | str, | str, | A JSON Pointer path. |
|
||||
**from** | str, | str, | A JSON Pointer path. |
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,15 +0,0 @@
|
||||
# petstore_api.model.json_patch_request_remove.JSONPatchRequestRemove
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**op** | str, | str, | The operation to perform. | must be one of ["remove", ]
|
||||
**path** | str, | str, | A JSON Pointer path. |
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,17 +0,0 @@
|
||||
# petstore_api.model.mammal.Mammal
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | |
|
||||
|
||||
### Composed Schemas (allOf/anyOf/oneOf/not)
|
||||
#### oneOf
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
[Whale](Whale.md) | [**Whale**](Whale.md) | [**Whale**](Whale.md) | |
|
||||
[Zebra](Zebra.md) | [**Zebra**](Zebra.md) | [**Zebra**](Zebra.md) | |
|
||||
[Pig](Pig.md) | [**Pig**](Pig.md) | [**Pig**](Pig.md) | |
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,66 +0,0 @@
|
||||
# petstore_api.model.map_test.MapTest
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**[map_map_of_string](#map_map_of_string)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional]
|
||||
**[map_of_enum_string](#map_of_enum_string)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional]
|
||||
**[direct_map](#direct_map)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional]
|
||||
**indirect_map** | [**StringBooleanMap**](StringBooleanMap.md) | [**StringBooleanMap**](StringBooleanMap.md) | | [optional]
|
||||
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
# map_map_of_string
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**[any_string_name](#any_string_name)** | dict, frozendict.frozendict, | frozendict.frozendict, | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
# any_string_name
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**any_string_name** | str, | str, | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
# map_of_enum_string
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**any_string_name** | str, | str, | any string name can be used but the value must be the correct type | [optional] must be one of ["UPPER", "lower", ]
|
||||
|
||||
# direct_map
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**any_string_name** | bool, | BoolClass, | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,29 +0,0 @@
|
||||
# petstore_api.model.mixed_properties_and_additional_properties_class.MixedPropertiesAndAdditionalPropertiesClass
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**uuid** | str, uuid.UUID, | str, | | [optional] value must be a uuid
|
||||
**dateTime** | str, datetime, | str, | | [optional] value must conform to RFC-3339 date-time
|
||||
**[map](#map)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional]
|
||||
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
# map
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**any_string_name** | [**Animal**](Animal.md) | [**Animal**](Animal.md) | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,18 +0,0 @@
|
||||
# petstore_api.model.model200_response.Model200Response
|
||||
|
||||
model with an invalid class name for python, starts with a number
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | model with an invalid class name for python, starts with a number |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**name** | decimal.Decimal, int, | decimal.Decimal, | | [optional] value must be a 32 bit integer
|
||||
**class** | str, | str, | this is a reserved python keyword | [optional]
|
||||
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,17 +0,0 @@
|
||||
# petstore_api.model.model_return.ModelReturn
|
||||
|
||||
Model for testing reserved words
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | Model for testing reserved words |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**return** | decimal.Decimal, int, | decimal.Decimal, | this is a reserved python keyword | [optional] value must be a 32 bit integer
|
||||
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,16 +0,0 @@
|
||||
# petstore_api.model.money.Money
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**amount** | str, | str, | | value must be numeric and storable in decimal.Decimal
|
||||
**currency** | [**Currency**](Currency.md) | [**Currency**](Currency.md) | |
|
||||
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,19 +0,0 @@
|
||||
# petstore_api.model.name.Name
|
||||
|
||||
Model for testing model name same as property name
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | Model for testing model name same as property name |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**name** | decimal.Decimal, int, | decimal.Decimal, | | value must be a 32 bit integer
|
||||
**snake_case** | decimal.Decimal, int, | decimal.Decimal, | | [optional] value must be a 32 bit integer
|
||||
**property** | str, | str, | this is a reserved python keyword | [optional]
|
||||
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,15 +0,0 @@
|
||||
# petstore_api.model.no_additional_properties.NoAdditionalProperties
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**id** | decimal.Decimal, int, | decimal.Decimal, | | value must be a 64 bit integer
|
||||
**petId** | decimal.Decimal, int, | decimal.Decimal, | | [optional] value must be a 64 bit integer
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,147 +0,0 @@
|
||||
# petstore_api.model.nullable_class.NullableClass
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**integer_prop** | None, decimal.Decimal, int, | NoneClass, decimal.Decimal, | | [optional]
|
||||
**number_prop** | None, decimal.Decimal, int, float, | NoneClass, decimal.Decimal, | | [optional]
|
||||
**boolean_prop** | None, bool, | NoneClass, BoolClass, | | [optional]
|
||||
**string_prop** | None, str, | NoneClass, str, | | [optional]
|
||||
**date_prop** | None, str, date, | NoneClass, str, | | [optional] value must conform to RFC-3339 full-date YYYY-MM-DD
|
||||
**datetime_prop** | None, str, datetime, | NoneClass, str, | | [optional] value must conform to RFC-3339 date-time
|
||||
**[array_nullable_prop](#array_nullable_prop)** | list, tuple, None, | tuple, NoneClass, | | [optional]
|
||||
**[array_and_items_nullable_prop](#array_and_items_nullable_prop)** | list, tuple, None, | tuple, NoneClass, | | [optional]
|
||||
**[array_items_nullable](#array_items_nullable)** | list, tuple, | tuple, | | [optional]
|
||||
**[object_nullable_prop](#object_nullable_prop)** | dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | | [optional]
|
||||
**[object_and_items_nullable_prop](#object_and_items_nullable_prop)** | dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | | [optional]
|
||||
**[object_items_nullable](#object_items_nullable)** | dict, frozendict.frozendict, | frozendict.frozendict, | | [optional]
|
||||
**[any_string_name](#any_string_name)** | dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
# array_nullable_prop
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
list, tuple, None, | tuple, NoneClass, | |
|
||||
|
||||
### Tuple Items
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
[items](#items) | dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
# items
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
# array_and_items_nullable_prop
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
list, tuple, None, | tuple, NoneClass, | |
|
||||
|
||||
### Tuple Items
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
[items](#items) | dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | |
|
||||
|
||||
# items
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | |
|
||||
|
||||
# array_items_nullable
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
list, tuple, | tuple, | |
|
||||
|
||||
### Tuple Items
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
[items](#items) | dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | |
|
||||
|
||||
# items
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | |
|
||||
|
||||
# object_nullable_prop
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**[any_string_name](#any_string_name)** | dict, frozendict.frozendict, | frozendict.frozendict, | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
# any_string_name
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
# object_and_items_nullable_prop
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**[any_string_name](#any_string_name)** | dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
# any_string_name
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | |
|
||||
|
||||
# object_items_nullable
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, | frozendict.frozendict, | |
|
||||
|
||||
### Dictionary Keys
|
||||
Key | Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
**[any_string_name](#any_string_name)** | dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | any string name can be used but the value must be the correct type | [optional]
|
||||
|
||||
# any_string_name
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | |
|
||||
|
||||
# any_string_name
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, None, | frozendict.frozendict, NoneClass, | |
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,26 +0,0 @@
|
||||
# petstore_api.model.nullable_shape.NullableShape
|
||||
|
||||
The value may be a shape or the 'null' value. For a composed schema to validate a null payload, one of its chosen oneOf schemas must be type null or nullable (introduced in OAS schema >= 3.0)
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | The value may be a shape or the 'null' value. For a composed schema to validate a null payload, one of its chosen oneOf schemas must be type null or nullable (introduced in OAS schema >= 3.0) |
|
||||
|
||||
### Composed Schemas (allOf/anyOf/oneOf/not)
|
||||
#### oneOf
|
||||
Class Name | Input Type | Accessed Type | Description | Notes
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
[Triangle](Triangle.md) | [**Triangle**](Triangle.md) | [**Triangle**](Triangle.md) | |
|
||||
[Quadrilateral](Quadrilateral.md) | [**Quadrilateral**](Quadrilateral.md) | [**Quadrilateral**](Quadrilateral.md) | |
|
||||
[one_of_2](#one_of_2) | None, | NoneClass, | |
|
||||
|
||||
# one_of_2
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
None, | NoneClass, | |
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,9 +0,0 @@
|
||||
# petstore_api.model.nullable_string.NullableString
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
None, str, | NoneClass, str, | |
|
||||
|
||||
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
|
||||
|
||||
@@ -1,9 +0,0 @@
|
||||
# petstore_api.model.number.Number
|
||||
|
||||
## Model Type Info
|
||||
Input Type | Accessed Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
decimal.Decimal, int, float, | decimal.Decimal, | |
|
||||
|
||||
[[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
Reference in New Issue
Block a user