Skip to content

APISchema

Union Type

APISchema module-attribute

Contains details about the OpenAPI schema for a custom plugin. For more information, see custom plugin OpenAPI schemas. You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3 field.

Union Member Types

APISchemaPayload dataclass

Bases: _SerdeShape

The JSON or YAML-formatted payload defining the OpenAPI schema for a custom plugin.

Attributes

value instance-attribute
value: str

APISchemaS3 dataclass

Bases: _SerdeShape

Contains details about the S3 object containing the OpenAPI schema for a custom plugin. The schema could be in either JSON or YAML format.

Attributes

value instance-attribute
value: S3

APISchemaUnknown dataclass

Bases: _SerdeShape

Represents an unknown variant. If you receive this value, you will need to update your library to receive the parsed value. This value may not be deliberately sent.

Attributes

tag instance-attribute
tag: str