@comet-cli/plugin-documentation
Version:
Plugin for generating API documentation
9 lines (8 loc) • 678 B
TypeScript
import { ApiModel, Bodies, Body, Operation, Parameter, Resource, Schema, Server } from '@comet-cli/types';
export declare const getAllResources: (model: ApiModel) => Resource[];
export declare const getResolvedServerUrl: (server: Server) => string;
export declare const getJsonBody: (bodies: Bodies) => Body | undefined;
export declare const getOperationParameters: (resource: Resource, operation: Operation) => Parameter[];
export declare const getHumanReadableType: (schema?: Schema | undefined) => string | undefined;
export declare const resolveExampleUri: (uri: string, parameters: Parameter[]) => string;
export declare const isPrimitiveType: (schema: Schema) => boolean;