items.md

Items

petstore_api.components.schema.items

type: schemas.Schema

Description

component's name collides with the inner schema name

validate method

Input Type	Return Type	Notes
ItemsTupleInput, ItemsTuple	ItemsTuple

ItemsTupleInput

type: typing.Union[
    typing.List[
        typing.Union[
            typing.Mapping[str, schemas.INPUT_TYPES_ALL],
            schemas.immutabledict[str, schemas.OUTPUT_BASE_TYPES],
        ],
    ],
    typing.Tuple[
        typing.Union[
            typing.Mapping[str, schemas.INPUT_TYPES_ALL],
            schemas.immutabledict[str, schemas.OUTPUT_BASE_TYPES],
        ],
        ...
    ]
]

List/Tuple Item Type	Description	Notes
dict, schemas.immutabledict

ItemsTuple

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

__new__ method

Argument	Type
arg	ItemsTupleInput, ItemsTuple
configuration	typing.Optional[schema_configuration.SchemaConfiguration] = None

methods

Method	Input Type	Return Type	Notes
__getitem__	int	schemas.immutabledict	This method is used under the hood when instance[0] is called

Items2

type: schemas.Schema

validate method

Input Type	Return Type	Notes
dict, schemas.immutabledict	schemas.immutabledict

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