@mintlify/scraping/bin/openapi/common.d.ts

Scrape documentation frameworks to Mintlify docs

import type { DecoratedNavigationPage, NavigationEntry } from '@mintlify/models';
import { OpenAPI, OpenAPIV3 } from 'openapi-types';
export declare const getOpenApiDefinition: (pathOrDocumentOrUrl: string | OpenAPI.Document | URL) => Promise<{
    document: OpenAPI.Document;
    isUrl: boolean;
}>;
export declare const generateUniqueFilenameWithoutExtension: (pages: NavigationEntry[], base: string) => string;
export declare const createOpenApiFrontmatter: (filename: string, openApiMetaTag: string, version?: string) => Promise<void>;
export declare const prepareStringToBeValidFilename: (str?: string) => string | undefined;
export type GenerateOpenApiPagesOptions = {
    openApiFilePath?: string;
    version?: string;
    writeFiles?: boolean;
    outDir?: string;
    outDirBasePath?: string;
    overwrite?: boolean;
};
export type OpenApiPageGenerationResult<N, DN> = {
    nav: N;
    decoratedNav: DN;
    spec: OpenAPI.Document;
    pagesAcc: Record<string, DecoratedNavigationPage>;
    isUrl: boolean;
};
export declare function processOpenApiPath<N, DN>(path: string, pathItemObject: OpenAPIV3.PathItemObject, schema: OpenAPI.Document, nav: N, decoratedNav: DN, writePromises: Promise<void>[], pagesAcc: Record<string, DecoratedNavigationPage>, options: GenerateOpenApiPagesOptions, findNavGroup: (nav: any, groupName?: string) => any): void;
export declare const DEFAULT_API_GROUP_NAME = "API Reference";
export declare const DEFAULT_WEBHOOK_GROUP_NAME = "Webhooks";
export declare function processOpenApiWebhook<N, DN>(webhook: string, webhookObject: OpenAPIV3.PathItemObject, _schema: OpenAPI.Document, nav: N, decoratedNav: DN, writePromises: Promise<void>[], pagesAcc: Record<string, DecoratedNavigationPage>, options: GenerateOpenApiPagesOptions, findNavGroup: (nav: any, groupName?: string) => any): void;