AutoBE
    Preparing search index...

    Reusable components in OpenAPI.

    A storage of reusable components in OpenAPI document.

    In other words, it is a storage of named DTO schemas and security schemes.

    interface IComponents {
        authorization: IAuthorization[];
        schemas: Record<string, AutoBeOpenApi.IJsonSchemaDescriptive>;
    }
    Index

    Properties

    authorization: IAuthorization[]

    Whether includes Authorization header or not.

    schemas: Record<string, AutoBeOpenApi.IJsonSchemaDescriptive>

    An object to hold reusable DTO schemas.

    In other words, a collection of named JSON schemas.

    IMPORTANT: For each schema in this collection:

    1. EVERY schema MUST have a detailed description that references and aligns with the description comments from the corresponding Prisma DB schema tables
    2. EACH property within the schema MUST have detailed descriptions that reference and align with the description comments from the corresponding DB schema columns
    3. All descriptions MUST be organized into MULTIPLE PARAGRAPHS (separated by line breaks) when appropriate
    4. Descriptions should be comprehensive enough that anyone reading them can understand the purpose, functionality, and constraints of each type and property without needing to reference other documentation