UNPKG

@redocly/openapi-core

Version:

See https://github.com/Redocly/openapi-cli

46 lines (45 loc) 1.76 kB
import { BaseResolver, Document } from './resolve'; import { Oas3Rule } from './visitors'; import { NormalizedNodeType, NodeType } from './types'; import { OasMajorVersion } from './oas-types'; import type { Config, LintConfig } from './config/config'; export declare type Oas3RuleSet = Record<string, Oas3Rule>; export declare enum OasVersion { Version2 = "oas2", Version3_0 = "oas3_0", Version3_1 = "oas3_1" } export declare function bundle(opts: { ref?: string; doc?: Document; externalRefResolver?: BaseResolver; config: Config; dereference?: boolean; base?: string; skipRedoclyRegistryRefs?: boolean; removeUnusedComponents?: boolean; }): Promise<{ bundle: Document; problems: import("./walk").NormalizedProblem[]; fileDependencies: Set<string>; rootType: NormalizedNodeType; refTypes: Map<string, NormalizedNodeType> | undefined; visitorsData: Record<string, Record<string, unknown>>; }>; export declare function bundleDocument(opts: { document: Document; config: LintConfig; customTypes?: Record<string, NodeType>; externalRefResolver: BaseResolver; dereference?: boolean; skipRedoclyRegistryRefs?: boolean; removeUnusedComponents?: boolean; }): Promise<{ bundle: Document; problems: import("./walk").NormalizedProblem[]; fileDependencies: Set<string>; rootType: NormalizedNodeType; refTypes: Map<string, NormalizedNodeType> | undefined; visitorsData: Record<string, Record<string, unknown>>; }>; export declare function mapTypeToComponent(typeName: string, version: OasMajorVersion): "headers" | "responses" | "definitions" | "parameters" | "schemas" | "examples" | "requestBodies" | "securitySchemes" | "links" | "callbacks" | null;