Libraries
    Preparing search index...

    Interface OpenApiEndpointOptions

    Options for createOpenApiEndpoint.

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

    interface OpenApiEndpointOptions {
        authConfig?: AuthenticationConfig | null;
        getRegistrations?: () => readonly EndpointRegistration[];
        info: OpenApiInfo;
        path?: string;
        securitySchemes?: Record<string, OpenApiSecurityScheme>;
        server?: OpenApiServer_ServerLike;
        servers?: readonly OpenApiServer[];
    }
    Index

    Properties

    authConfig? getRegistrations? info path? securitySchemes? server? servers?

    Properties

    authConfig?: AuthenticationConfig | null

    Optional auth config for security scheme generation.

    getRegistrations?: () => readonly EndpointRegistration[]

    Function that returns endpoint registrations.

    info: OpenApiInfo

    OpenAPI info metadata.

    path?: string

    Path to serve the spec at (default: /openapi.json).

    securitySchemes?: Record<string, OpenApiSecurityScheme>

    Override security schemes manually.

    server?: OpenApiServer_ServerLike

    A ServerBuilder (or any structurally compatible object). When set, endpoint registrations and auth config are read from the server automatically. Explicit getRegistrations / authConfig values take precedence.

    servers?: readonly OpenApiServer[]

    Optional server entries.

    Settings

    Member Visibility

    On This Page

    Properties