Skip to content

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

The items in the schema definition. This field is used for array types to define the structure of the array elements.

properties instance-attribute

The properties of the schema definition. These properties define the fields in the schema.

required instance-attribute
required: Sequence[str] | None

The required fields in the schema definition. These fields must be provided when using the schema.

type instance-attribute
type: Required[str]

The type of the schema definition. This field specifies the data type of the schema.