vitepress-openapi/dist/types/src/lib/parser/parseOpenapi.d.ts

Generate VitePress API Documentation from OpenAPI Specification.

import type { OpenAPIDocument, ParsedOpenAPI } from '../../types';
export declare function parseOpenapi(): {
    transformSync: ({ spec, defaultTag, defaultTagDescription, }: {
        spec: OpenAPIDocument | string;
        defaultTag?: string;
        defaultTagDescription?: string;
    }) => {
        [customExtension: `x-${string}`]: any;
        [key: string]: any;
        openapi?: undefined;
        swagger?: never;
        info?: (import("@scalar/openapi-types").OpenAPIV3.InfoObject & Omit<import("@scalar/openapi-types").OpenAPIV3.InfoObject, "license" | "summary"> & {
            summary?: string;
            license?: import("@scalar/openapi-types").OpenAPIV3_1.LicenseObject;
        }) | undefined;
        servers?: (import("@scalar/openapi-types").OpenAPIV3.ServerObject[] & import("@scalar/openapi-types").OpenAPIV3_1.ServerObject[]) | undefined;
        paths?: (import("@scalar/openapi-types").OpenAPIV3.PathsObject<{}, {}> & import("@scalar/openapi-types").OpenAPIV3_1.PathsObject<{}, {}>) | undefined;
        components?: (import("@scalar/openapi-types").OpenAPIV3.ComponentsObject & Omit<import("@scalar/openapi-types").OpenAPIV3.ComponentsObject, "parameters" | "responses" | "examples" | "callbacks" | "headers" | "links" | "schemas" | "requestBodies" | "securitySchemes" | "pathItems"> & {
            schemas?: Record<string, import("@scalar/openapi-types").OpenAPIV3_1.SchemaObject>;
            responses?: Record<string, import("@scalar/openapi-types").OpenAPIV3_1.ReferenceObject | import("@scalar/openapi-types").OpenAPIV3_1.ResponseObject>;
            parameters?: Record<string, import("@scalar/openapi-types").OpenAPIV3_1.ReferenceObject | import("@scalar/openapi-types").OpenAPIV3_1.ParameterObject>;
            examples?: Record<string, import("@scalar/openapi-types").OpenAPIV3_1.ReferenceObject | import("@scalar/openapi-types").OpenAPIV3_1.ExampleObject>;
            requestBodies?: Record<string, import("@scalar/openapi-types").OpenAPIV3_1.ReferenceObject | import("@scalar/openapi-types").OpenAPIV3_1.RequestBodyObject>;
            headers?: Record<string, import("@scalar/openapi-types").OpenAPIV3_1.ReferenceObject | import("@scalar/openapi-types").OpenAPIV3_1.HeaderObject>;
            securitySchemes?: Record<string, import("@scalar/openapi-types").OpenAPIV3_1.ReferenceObject | import("@scalar/openapi-types").OpenAPIV3_1.SecuritySchemeObject>;
            links?: Record<string, import("@scalar/openapi-types").OpenAPIV3_1.ReferenceObject | import("@scalar/openapi-types").OpenAPIV3_1.LinkObject>;
            callbacks?: Record<string, import("@scalar/openapi-types").OpenAPIV3_1.ReferenceObject | import("@scalar/openapi-types").OpenAPIV3_1.CallbackObject>;
            pathItems?: Record<string, import("@scalar/openapi-types").OpenAPIV3_1.ReferenceObject | import("@scalar/openapi-types").OpenAPIV3_1.PathItemObject>;
        }) | undefined;
        security?: import("@scalar/openapi-types").OpenAPIV3.SecurityRequirementObject[];
        tags?: import("@scalar/openapi-types").OpenAPIV3.TagObject[];
        externalDocs?: import("@scalar/openapi-types").OpenAPIV3.ExternalDocumentationObject;
        jsonSchemaDialect?: string;
        webhooks?: Record<string, import("@scalar/openapi-types").OpenAPIV3_1.PathItemObject | import("@scalar/openapi-types").OpenAPIV3_1.ReferenceObject> | undefined;
    };
    transformAsync: ({ spec, }: {
        spec: ParsedOpenAPI | string;
    }) => Promise<ParsedOpenAPI>;
    parseSync: ({ spec, defaultTag, defaultTagDescription, }: {
        spec: OpenAPIDocument | string;
        defaultTag?: string;
        defaultTagDescription?: string;
    }) => ParsedOpenAPI;
    parseAsync: ({ spec, defaultTag, defaultTagDescription, }: {
        spec: OpenAPIDocument | string;
        defaultTag?: string;
        defaultTagDescription?: string;
    }) => Promise<ParsedOpenAPI>;
};