vitepress-openapi
Version:
Generate VitePress API Documentation from OpenAPI Specification.
116 lines (115 loc) • 4.46 kB
TypeScript
import type { OpenAPIV3 } from '@scalar/openapi-types';
declare const _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
request: {
type: ObjectConstructor;
};
operationId: {
type: StringConstructor;
required: true;
};
path: {
type: StringConstructor;
required: true;
};
method: {
type: StringConstructor;
required: true;
};
baseUrl: {
type: StringConstructor;
required: true;
};
servers: {
type: ArrayConstructor;
default: () => never[];
};
parameters: {
type: {
(arrayLength: number): OpenAPIV3.ParameterObject[];
(...items: OpenAPIV3.ParameterObject[]): OpenAPIV3.ParameterObject[];
new (arrayLength: number): OpenAPIV3.ParameterObject[];
new (...items: OpenAPIV3.ParameterObject[]): OpenAPIV3.ParameterObject[];
isArray(arg: any): arg is any[];
readonly prototype: any[];
from<T>(arrayLike: ArrayLike<T>): T[];
from<T, U>(arrayLike: ArrayLike<T>, mapfn: (v: T, k: number) => U, thisArg?: any): U[];
from<T>(iterable: Iterable<T> | ArrayLike<T>): T[];
from<T, U>(iterable: Iterable<T> | ArrayLike<T>, mapfn: (v: T, k: number) => U, thisArg?: any): U[];
of<T>(...items: T[]): T[];
fromAsync<T>(iterableOrArrayLike: AsyncIterable<T> | Iterable<T | PromiseLike<T>> | ArrayLike<T | PromiseLike<T>>): Promise<T[]>;
fromAsync<T, U>(iterableOrArrayLike: AsyncIterable<T> | Iterable<T> | ArrayLike<T>, mapFn: (value: Awaited<T>, index: number) => U, thisArg?: any): Promise<Awaited<U>[]>;
readonly [Symbol.species]: ArrayConstructor;
};
required: true;
};
securityUi: {
type: ObjectConstructor;
required: true;
};
examples: {
type: ObjectConstructor;
required: false;
};
}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
submit: (...args: any[]) => void;
"update:request": (...args: any[]) => void;
"update:selectedServer": (...args: any[]) => void;
}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
request: {
type: ObjectConstructor;
};
operationId: {
type: StringConstructor;
required: true;
};
path: {
type: StringConstructor;
required: true;
};
method: {
type: StringConstructor;
required: true;
};
baseUrl: {
type: StringConstructor;
required: true;
};
servers: {
type: ArrayConstructor;
default: () => never[];
};
parameters: {
type: {
(arrayLength: number): OpenAPIV3.ParameterObject[];
(...items: OpenAPIV3.ParameterObject[]): OpenAPIV3.ParameterObject[];
new (arrayLength: number): OpenAPIV3.ParameterObject[];
new (...items: OpenAPIV3.ParameterObject[]): OpenAPIV3.ParameterObject[];
isArray(arg: any): arg is any[];
readonly prototype: any[];
from<T>(arrayLike: ArrayLike<T>): T[];
from<T, U>(arrayLike: ArrayLike<T>, mapfn: (v: T, k: number) => U, thisArg?: any): U[];
from<T>(iterable: Iterable<T> | ArrayLike<T>): T[];
from<T, U>(iterable: Iterable<T> | ArrayLike<T>, mapfn: (v: T, k: number) => U, thisArg?: any): U[];
of<T>(...items: T[]): T[];
fromAsync<T>(iterableOrArrayLike: AsyncIterable<T> | Iterable<T | PromiseLike<T>> | ArrayLike<T | PromiseLike<T>>): Promise<T[]>;
fromAsync<T, U>(iterableOrArrayLike: AsyncIterable<T> | Iterable<T> | ArrayLike<T>, mapFn: (value: Awaited<T>, index: number) => U, thisArg?: any): Promise<Awaited<U>[]>;
readonly [Symbol.species]: ArrayConstructor;
};
required: true;
};
securityUi: {
type: ObjectConstructor;
required: true;
};
examples: {
type: ObjectConstructor;
required: false;
};
}>> & Readonly<{
onSubmit?: ((...args: any[]) => any) | undefined;
"onUpdate:request"?: ((...args: any[]) => any) | undefined;
"onUpdate:selectedServer"?: ((...args: any[]) => any) | undefined;
}>, {
servers: unknown[];
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
export default _default;