serverless-openapi/types.d.ts

Serverless plugin to generate OpenAPI V3 documentation from serverless configuration

import { JSONSchema7 } from "json-schema";
import { OpenAPIV3 } from "openapi-types";
export interface Model {
    name: string;
    description: string;
    contentType: string;
    schema: string | JSONSchema7;
    examples: Array<any>;
    example: object;
}
export interface DefinitionConfig {
    title: string;
    description: string;
    version?: string;
    securitySchemes: OpenAPIV3.SecuritySchemeObject;
    security: Array<OpenAPIV3.SecurityRequirementObject>;
    servers: Array<OpenAPIV3.ServerObject>;
    models: Array<Model>;
}
export declare enum Format {
    yaml = "yaml",
    json = "json"
}
export interface DefinitionType {
    file: string;
    format: Format;
    indent: number;
}
export interface ServerlessFunctionConfig {
    _functionName: string;
    handler: string;
    description?: string;
    environment?: object;
    events?: Array<any>;
}
export interface Operation {
    tags?: Array<string>;
    summary?: string;
    description?: string;
    externalDocs?: any;
    operationId?: string;
    parameters?: Array<ParameterConfig>;
    requestBody?: any;
    responses?: any;
    callbacks?: any;
    deprecated?: boolean;
    security?: Array<any>;
    servers?: Array<any>;
}
export interface ParameterConfig {
    name: string;
    in: "path" | "query" | "header" | "cookie";
    description: string;
    required?: boolean;
    schema?: object;
    deprecated?: boolean;
    allowEmptyValue?: boolean;
    style?: "form" | "simple";
    explode?: boolean;
    allowReserved?: boolean;
    example?: any;
    examples?: Array<any>;
    content?: Map<string, any>;
}
export interface Definition {
    openapi: string;
    info?: any;
    servers?: Array<any>;
    paths?: any;
    components?: any;
    security?: Array<any>;
    tags?: Array<any>;
    externalDocs?: any;
}
export declare type ILog = (...str: Array<string>) => void;