boundfetch
    Preparing search index...

    Interface OpenAPISpec

    Minimal OpenAPI 3.x document shape consumed by this package.

    Servers: Only servers[0].url is read, and only when it is an absolute http/https URL with no {template} segments. Relative URLs (for example /v1) and templated URLs are ignored so callers must set OpenAPIClientDeclarationOptions.baseUrl or OpenAPIClientDeclarationOptions.defaultBaseUrl.

    interface OpenAPISpec {
        components?: { schemas?: Record<string, OpenAPISchema> };
        info?: { title?: string; version?: string };
        openapi?: string;
        paths?: Record<
            string,
            Partial<
                Record<
                    "get"
                    | "post"
                    | "put"
                    | "patch"
                    | "delete"
                    | "head",
                    OpenAPIOperation,
                >,
            >,
        >;
        servers?: { url: string }[];
    }
    Index

    Properties

    components? info? openapi? paths? servers?

    Properties

    components?: { schemas?: Record<string, OpenAPISchema> }
    info?: { title?: string; version?: string }
    openapi?: string
    paths?: Record<
        string,
        Partial<
            Record<
                "get"
                | "post"
                | "put"
                | "patch"
                | "delete"
                | "head",
                OpenAPIOperation,
            >,
        >,
    >
    servers?: { url: string }[]

    Settings

    Member Visibility

    On This Page

    Properties