vitepress-openapi
Version:
Generate VitePress API Documentation from OpenAPI Specification.
100 lines (99 loc) • 3.8 kB
TypeScript
import OAContext from './OAContext.vue';
declare const openapiInstance: {
spec: import("../../types").OpenAPIDocument;
setSpec: (spec: any) => void;
getSpec: () => import("../../types").OpenAPIDocument;
getOperation: (operationId: string) => any;
getOperationPath: (operationId: string) => string | null;
getOperationMethod: (operationId: string) => string | null;
getOperationParameters: (operationId: string) => any;
getPaths: () => import("@scalar/openapi-types").OpenAPIV3.PathsObject;
getPathsByVerbs: () => ({
path: string;
verb: string;
operationId: any;
summary: any;
tags: any;
} | null)[];
getInfo: () => 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;
};
getExternalDocs: () => import("@scalar/openapi-types").OpenAPIV3.ExternalDocumentationObject;
getServers: () => import("@scalar/openapi-types").OpenAPIV3.ServerObject[] & import("@scalar/openapi-types").OpenAPIV3_1.ServerObject[];
getOperationServers: (operationId: string) => any[];
getOperationsTags: () => string[];
getPathsByTags: (tags: string | string[]) => import("@scalar/openapi-types").OpenAPIV3.PathsObject<{}, {}>;
getPathsWithoutTags: () => import("@scalar/openapi-types").OpenAPIV3.PathsObject<{}, {}>;
getTags: () => {
name: string | null;
description: string | null;
}[];
getFilteredTags: () => {
name: string | null;
description: string | null;
}[];
};
declare const __VLS_ctx: InstanceType<__VLS_PickNotAny<typeof __VLS_self, new () => {}>>;
declare var __VLS_5: {
openapi: any;
};
type __VLS_Slots = __VLS_PrettifyGlobal<__VLS_OmitStringIndex<typeof __VLS_ctx.$slots> & {
default?: (props: typeof __VLS_5) => any;
}>;
declare const __VLS_self: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
spec: {
type: ObjectConstructor;
required: false;
};
specUrl: {
type: StringConstructor;
required: false;
};
}>, {
OAContext: typeof OAContext;
openapiInstance: typeof openapiInstance;
}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
"update:spec": (...args: any[]) => void;
}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
spec: {
type: ObjectConstructor;
required: false;
};
specUrl: {
type: StringConstructor;
required: false;
};
}>> & Readonly<{
"onUpdate:spec"?: ((...args: any[]) => any) | undefined;
}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
declare const __VLS_component: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
spec: {
type: ObjectConstructor;
required: false;
};
specUrl: {
type: StringConstructor;
required: false;
};
}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
"update:spec": (...args: any[]) => void;
}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
spec: {
type: ObjectConstructor;
required: false;
};
specUrl: {
type: StringConstructor;
required: false;
};
}>> & Readonly<{
"onUpdate:spec"?: ((...args: any[]) => any) | undefined;
}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
declare const _default: __VLS_WithSlots<typeof __VLS_component, __VLS_Slots>;
export default _default;
type __VLS_WithSlots<T, S> = T & {
new (): {
$slots: S;
};
};