SchemaDefinitionDict¶
Dictionary Type¶
SchemaDefinitionDict
¶
Bases: TypedDict
Dictionary form of SchemaDefinition.
Attributes¶
description
instance-attribute
¶
description: str | None
The description of the schema definition. This description provides information about the purpose and usage of the schema.
items
instance-attribute
¶
items: SchemaDefinition | SchemaDefinitionDict | None
The items in the schema definition. This field is used for array types to define the structure of the array elements.
properties
instance-attribute
¶
properties: Mapping[str, SchemaDefinition | SchemaDefinitionDict] | None
The properties of the schema definition. These properties define the fields in the schema.
required
instance-attribute
¶
The required fields in the schema definition. These fields must be provided when using the schema.