Skip to content

SchemaDefinition

Structure Class

SchemaDefinition dataclass

Bases: _SerdeShape

A schema definition for a gateway target. This structure defines the structure of the API that the target exposes.

Attributes

description class-attribute instance-attribute
description: str | None = ...

The description of the schema definition. This description provides information about the purpose and usage of the schema.

items class-attribute instance-attribute
items: SchemaDefinition | None = ...

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

properties class-attribute instance-attribute
properties: dict[str, SchemaDefinition] | None = ...

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

required class-attribute instance-attribute
required: list[str] | None = ...

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

type instance-attribute
type: str

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