Skip to content
This repository was archived by the owner on Dec 25, 2024. It is now read-only.

Latest commit

 

History

History
49 lines (42 loc) · 2.24 KB

File metadata and controls

49 lines (42 loc) · 2.24 KB

Whale

petstore_api.components.schema.whale

type: schemas.Schema

validate method

Input Type Return Type Notes
WhaleDictInput, WhaleDict WhaleDict

WhaleDictInput

type: typing.Mapping[str, schemas.INPUT_TYPES_ALL]
Key Type Description Notes
className typing.Literal["whale"] must be one of ["whale"]
hasBaleen bool [optional]
hasTeeth bool [optional]
any_string_name dict, schemas.immutabledict, list, tuple, decimal.Decimal, float, int, str, datetime.date, datetime.datetime, uuid.UUID, bool, None, bytes, io.FileIO, io.BufferedReader, schemas.FileIO any string name can be used but the value must be the correct type [optional]

WhaleDict

base class: schemas.immutabledict[str, schemas.OUTPUT_BASE_TYPES]

__new__ method

Keyword Argument Type Description Notes
className typing.Literal["whale"] must be one of ["whale"]
hasBaleen bool, schemas.Unset [optional]
hasTeeth bool, schemas.Unset [optional]
kwargs schemas.immutabledict, tuple, float, int, str, bool, None, bytes, schemas.FileIO any string name can be used but the value must be the correct type [optional] typed value is accessed with the get_additional_property_ method

properties

Property Type Description Notes
className typing.Literal["whale"] must be one of ["whale"]
hasBaleen bool, schemas.Unset [optional]
hasTeeth bool, schemas.Unset [optional]

methods

Method Input Type Return Type Notes
from_dict_ WhaleDictInput, WhaleDict WhaleDict a constructor
get_additional_property_ str schemas.immutabledict, tuple, float, int, str, bool, None, bytes, schemas.FileIO, schemas.Unset provides type safety for additional properties

[Back to top] [Back to Component Schemas] [Back to README]