UNPKG

@svengroup/openapi-to-pdf

Version:

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

12 lines (11 loc) 1.01 kB
import { Config, SecuritySchemeType } from "../types"; import { OpenAPIV3 } from "openapi-types"; import { SecuritySchemes } from "../types"; export default function generateSecurityMarkdown(schema: OpenAPIV3.Document, config?: Partial<Config>): Promise<string>; export declare function generateApiKeysMarkdown(security_schemes: SecuritySchemes): Promise<string>; export declare function generateBasicMarkdown(security_schemes: SecuritySchemes): string; export declare function generateBearerMarkdown(security_schemes: SecuritySchemes): string; export declare function generateOidcMarkdown(security_schemes: SecuritySchemes): string; export declare function generateOauthMarkdown(security_schemes: SecuritySchemes): Promise<string>; export declare function generateOauthFlowsMarkdown(security_scheme: OpenAPIV3.OAuth2SecurityScheme): Promise<string>; export declare function getMatchingSecuritySchemes(security_schemes: SecuritySchemes, type: SecuritySchemeType, scheme?: 'basic' | 'bearer'): SecuritySchemes;