@svengroup/openapi-to-pdf/dist/markdown/endpoints/index.d.ts

Create PDF API reference documentation from OpenAPI 3.0.x specification files.

import { OpenAPIV3 } from "openapi-types";
import { Config, Operations } from "../../types";
export default function generateEndpointsMarkdown(schema: OpenAPIV3.Document, config?: Partial<Config>): string;
export declare function getActualTags(paths: OpenAPIV3.PathsObject): string[];
export declare function getTagObject(name: string, tags?: OpenAPIV3.TagObject[]): OpenAPIV3.TagObject | null;
export declare function getOperationsFromPath(path_item: OpenAPIV3.PathItemObject, tag?: string, find_no_tag?: boolean): Operations;
export declare function generateTagMarkdown(actual_tag: string, tags?: OpenAPIV3.TagObject[]): string;
export declare function generateOperationsWithTagsMarkdown(paths: OpenAPIV3.PathsObject, actual_tags: string[], tags?: OpenAPIV3.TagObject[], config?: Partial<Config>): string;
export declare function generateUntaggedOperationsMarkdown(tags?: OpenAPIV3.TagObject[], config?: Partial<Config>): string;
export declare function generateOperationMarkdown(h: string, operation: OpenAPIV3.OperationObject, path_item?: OpenAPIV3.PathItemObject): string;
export declare function generateOperationTitleMarkdown(h: string, path: string, method: string, operation: OpenAPIV3.OperationObject): string;
export declare function getParameters(path_parameters?: OpenAPIV3.ParameterObject[], operation_parameters?: OpenAPIV3.ParameterObject[]): OpenAPIV3.ParameterObject[];
export declare function generateOperationSecurityMarkdown(h: string, security_requirements?: OpenAPIV3.SecurityRequirementObject[]): string;
export declare function generateMediaTypeMarkdown(media_type: string, obj: OpenAPIV3.MediaTypeObject, display_for?: 'response' | 'request'): string;