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

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

import { OpenAPIV3 } from "openapi-types";
export declare function generateSchemaMarkdown(schema: OpenAPIV3.SchemaObject, display_for?: 'response' | 'request'): string;
export declare function generateSchemaBasicTableMarkdown(schema: OpenAPIV3.SchemaObject): string;
export declare function generateSchemaTableMarkdown(schema: OpenAPIV3.SchemaObject, display_for?: 'response' | 'request'): string;
export declare function generateAddtlPropSchemaTableRowMarkdown(base_key: string, schema: OpenAPIV3.SchemaObject, display_for?: 'response' | 'request'): string;
export declare function handleAllOf(schema: OpenAPIV3.SchemaObject): OpenAPIV3.SchemaObject;
export declare function generateSchemaTableRowMarkdown(key: string, schema: OpenAPIV3.SchemaObject, required_properties?: string[], display_for?: 'response' | 'request'): string;
export declare function generateSchemaTableRowRequiredColMarkdown(key: string, required_properties?: string[]): string;
export declare function generateSchemaTableRowExampleColMarkdown(schema: OpenAPIV3.SchemaObject): string;
export declare function generateOneAnyOfSchemaTableRowMarkdown(key: string, schema: OpenAPIV3.SchemaObject, required_properties?: string[], display_for?: 'response' | 'request'): string;
export declare function generateNestedSchemaTableRowMarkdown(key: string, schema: OpenAPIV3.SchemaObject, display_for?: 'response' | 'request'): string;
export declare function generateNestedArraySchemaTableRowMarkdown(base_key: string, schema: OpenAPIV3.SchemaObject, display_for?: 'response' | 'request'): string;
export declare function generateNestedObjectSchemaTableRowMarkdown(base_key: string, schema: OpenAPIV3.SchemaObject, display_for?: 'response' | 'request'): string;
export declare function generateSchemaNotesMarkdown(schema?: OpenAPIV3.SchemaObject): string;
export declare function getNotes(notes: string[], schema: OpenAPIV3.SchemaObject): string[];