fruit.md

Fruit

petstore_api.components.schema.fruit

type: schemas.Schema

validate method

Input Type	Return Type	Notes
FruitDictInput, FruitDict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader	FruitDict, str, float, int, bool, None, tuple, bytes, io.FileIO

FruitDictInput

type: typing.Mapping[str, schemas.INPUT_TYPES_ALL]

Key	Type	Description	Notes
color	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]

FruitDict

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

__new__ method

Keyword Argument	Type	Description	Notes
color	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
color	str, schemas.Unset		[optional]

methods

Method	Input Type	Return Type	Notes
from_dict_	FruitDictInput, FruitDict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader	FruitDict, str, float, int, bool, None, tuple, bytes, io.FileIO	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

Composed Schemas (allOf/anyOf/oneOf/not)

oneOf

Schema Class	Input Type	Return Type
apple.Apple	None, apple.AppleDictInput, apple.AppleDict	None, apple.AppleDict
banana.Banana	banana.BananaDictInput, banana.BananaDict	banana.BananaDict

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