SchemaDefinition¶
Structure Class¶
dataclass
¶
A schema definition for a gateway target. This structure defines the structure of the API that the target exposes.
Attributes¶
class-attribute
instance-attribute
¶
description: str | None = None
The description of the schema definition. This description provides information about the purpose and usage of the schema.
class-attribute
instance-attribute
¶
items: SchemaDefinition | None = None
The items in the schema definition. This field is used for array types to define the structure of the array elements.
class-attribute
instance-attribute
¶
properties: dict[str, SchemaDefinition] | None = None
The properties of the schema definition. These properties define the fields in the schema.
class-attribute
instance-attribute
¶
required: list[str] | None = None
The required fields in the schema definition. These fields must be provided when using the schema.
instance-attribute
¶
type: SchemaType
The type of the schema definition. This field specifies the data type of the schema.