Skip to content

Latest commit

 

History

History
49 lines (42 loc) · 2.31 KB

File metadata and controls

49 lines (42 loc) · 2.31 KB

ApiResponse

petstore_api.components.schema.api_response

type: schemas.Schema

validate method

Input Type Return Type Notes
ApiResponseDictInput, ApiResponseDict ApiResponseDict

ApiResponseDictInput

type: typing.Mapping[str, schemas.INPUT_TYPES_ALL]
Key Type Description Notes
code int [optional] value must be a 32 bit integer
type str [optional]
message str [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]

ApiResponseDict

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

__new__ method

Keyword Argument Type Description Notes
code int, schemas.Unset [optional] value must be a 32 bit integer
type str, schemas.Unset [optional]
message str, 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
code int, schemas.Unset [optional] value must be a 32 bit integer
type str, schemas.Unset [optional]
message str, schemas.Unset [optional]

methods

Method Input Type Return Type Notes
from_dict_ ApiResponseDictInput, ApiResponseDict ApiResponseDict 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]