Documentation
    Preparing search index...

    Shared schema component definitions.

    Contains named schema definitions that can be referenced via $ref throughout the application's function schemas. Reduces duplication and enables recursive type definitions.

    interface IComponents<
        Schema extends
            OpenApi.IJsonSchema
            | OpenApiV3.IJsonSchema = OpenApi.IJsonSchema,
    > {
        schemas?: Record<string, Schema>;
    }

    Type Parameters

    Index

    Properties

    Properties

    schemas?: Record<string, Schema>

    Named schema definitions for reference.

    Keys are type names, values are their JSON Schema definitions. Reference these using $ref: "#/components/schemas/TypeName".