Libraries
    Preparing search index...

    Options passed to generateOpenApiSpec.

    When server is provided, registrations and authConfig are derived from it automatically (unless explicitly overridden).

    interface OpenApiOptions {
        authConfig?: AuthenticationConfig | null;
        info: OpenApiInfo;
        registrations?: readonly EndpointRegistration[];
        securitySchemes?: Record<string, OpenApiSecurityScheme>;
        server?: OpenApiServer_ServerLike;
        servers?: readonly OpenApiServer[];
        tags?: readonly OpenApiTag[];
        webhooks?: readonly WebhookDefinition[];
    }
    Index

    Properties

    authConfig?: AuthenticationConfig | null
    registrations?: readonly EndpointRegistration[]
    securitySchemes?: Record<string, OpenApiSecurityScheme>

    A ServerBuilder (or any object implementing the same methods). When set, registrations, authConfig, and webhooks are automatically read from the server instance. Explicit values for those fields take precedence over the server-derived ones.

    servers?: readonly OpenApiServer[]
    tags?: readonly OpenApiTag[]

    Top-level tag definitions with optional descriptions and external docs.

    When provided, these entries are emitted as the top-level tags array. Any tag names used by registered endpoints but absent from this list are automatically appended as name-only entries (sorted alphabetically).

    When omitted, unique tag names are still auto-collected from all registered endpoints and emitted as name-only entries.

    webhooks?: readonly WebhookDefinition[]

    Webhook definitions to emit in the top-level webhooks map of the generated OpenAPI document.

    Webhooks are not served as HTTP routes — they merely document async out-of-band requests that your API sends to subscribers.