openapi-axios
Version:
OpenAPI(2.0/3.0/3.1) Schema → Type-safe Axios
37 lines (36 loc) • 1.41 kB
TypeScript
import { OpenAPILatest } from '../types/openapi';
export declare class JsDoc {
private tags;
lines: string[];
constructor(tags?: OpenAPILatest.TagObject[]);
addComments(comments: Record<string, unknown>): void;
addLines(lines: string[]): void;
print(): string;
static toLines(comments: Record<string, unknown>): string[];
static fromRef(ref: OpenAPILatest.ReferenceObject): {
description: string | undefined;
summary: string | undefined;
};
static fromSchema(schema: OpenAPILatest.SchemaObject): {
summary: string | undefined;
description: string | undefined;
deprecated: boolean | undefined;
default: any;
format: string | undefined;
example: any;
examples: any[] | undefined;
externalDocs: import('../types/openapi-3_0').ExternalDocumentationObject | undefined;
};
static fromParameter(parameter: OpenAPILatest.ParameterObject): {
deprecated: boolean | undefined;
description: string | undefined;
example: any;
};
static fromOperation(operation: OpenAPILatest.OperationObject): {
deprecated: boolean | undefined;
description: string | undefined;
summary: string | undefined;
tags: string[] | undefined;
};
static printExternalDoc(externalDoc?: OpenAPILatest.ExternalDocumentationObject): string | false;
}