fumadocs-openapi
Version:
Generate MDX docs for your OpenAPI spec
20 lines • 815 B
TypeScript
import type { Document } from '../types.js';
import type { NoReference } from '../utils/schema.js';
import type { OpenAPIV3, OpenAPIV3_1 } from 'openapi-types';
export type ProcessedDocument = {
/**
* dereferenced document
*/
dereferenced: NoReference<Document>;
/**
* Get raw object from dereference object
*/
getRawRef: (obj: object) => string | undefined;
bundled: Document;
};
export declare function processDocumentCached(input: string | OpenAPIV3_1.Document | OpenAPIV3.Document): Promise<ProcessedDocument>;
/**
* process & reference input document to a Fumadocs OpenAPI compatible format
*/
export declare function processDocument(input: string | OpenAPIV3_1.Document | OpenAPIV3.Document): Promise<ProcessedDocument>;
//# sourceMappingURL=process-document.d.ts.map