Setu-TS
    Preparing search index...

    Interface OpenApiDocument

    OpenAPI 3.1 document structure.

    0.1.0

    interface OpenApiDocument {
        components?: {
            schemas?: Record<string, OpenApiSchemaObject>;
            securitySchemes?: Record<string, unknown>;
        };
        info: { description?: string; title: string; version: string };
        openapi: string;
        paths: Record<
            string,
            {
                delete?: OpenApiOperation;
                get?: OpenApiOperation;
                head?: OpenApiOperation;
                options?: OpenApiOperation;
                patch?: OpenApiOperation;
                post?: OpenApiOperation;
                put?: OpenApiOperation;
            },
        >;
        security?: readonly Readonly<Record<string, readonly string[]>>[];
        servers?: readonly { description?: string; url: string }[];
    }
    Index
    components? info openapi paths security? servers?
    components?: {
        schemas?: Record<string, OpenApiSchemaObject>;
        securitySchemes?: Record<string, unknown>;
    }

    Reusable components.

    info: { description?: string; title: string; version: string }

    API metadata.

    openapi: string

    OpenAPI version.

    paths: Record<
        string,
        {
            delete?: OpenApiOperation;
            get?: OpenApiOperation;
            head?: OpenApiOperation;
            options?: OpenApiOperation;
            patch?: OpenApiOperation;
            post?: OpenApiOperation;
            put?: OpenApiOperation;
        },
    >

    API paths.

    security?: readonly Readonly<Record<string, readonly string[]>>[]

    Document-level security requirements, applied to every operation that does not declare its own. An operation opts out with security: [].

    servers?: readonly { description?: string; url: string }[]

    Server URLs.

    Settings
    Member Visibility

    On This Page
    Properties