@foal/core/lib/core/openapi/decorators.d.ts

Full-featured Node.js framework, with no complexity

import 'reflect-metadata';
import { IApiCallback, IApiExample, IApiExternalDocumentation, IApiHeader, IApiInfo, IApiLink, IApiOperation, IApiParameter, IApiReference, IApiRequestBody, IApiResponse, IApiSchema, IApiSecurityRequirement, IApiSecurityScheme, IApiServer, IApiTag } from './interfaces';
export type OpenApiDecorator = (target: any, propertyKey?: string) => any;
export declare function ApiInfo(info: IApiInfo | ((controller: any) => IApiInfo)): OpenApiDecorator;
export declare function ApiOperationDescription(description: string | ((controller: any) => string)): OpenApiDecorator;
export declare function ApiOperationId(operationId: string | ((controller: any) => string)): OpenApiDecorator;
export declare function ApiOperationSummary(summary: string | ((controller: any) => string)): OpenApiDecorator;
export declare function ApiServer(server: IApiServer | ((controller: any) => IApiServer)): OpenApiDecorator;
export declare function ApiSecurityRequirement(securityRequirement: IApiSecurityRequirement | ((controller: any) => IApiSecurityRequirement)): OpenApiDecorator;
export declare function ApiDefineTag(tag: IApiTag | ((controller: any) => IApiTag)): OpenApiDecorator;
export declare function ApiExternalDoc(externalDoc: IApiExternalDocumentation | ((controller: any) => IApiExternalDocumentation)): OpenApiDecorator;
export declare function ApiOperation(operation: IApiOperation | ((controller: any) => IApiOperation)): OpenApiDecorator;
export declare function ApiUseTag(tag: string | ((controller: any) => string)): OpenApiDecorator;
export declare function ApiParameter(parameter: IApiParameter | IApiReference | ((controller: any) => IApiParameter | IApiReference)): OpenApiDecorator;
export declare function ApiRequestBody(requestBody: IApiRequestBody | IApiReference | ((controller: any) => IApiRequestBody | IApiReference)): OpenApiDecorator;
export declare function ApiResponse(key: 'default' | '1XX' | '2XX' | '3XX' | '4XX' | '5XX' | number, response: IApiResponse | IApiReference | ((controller: any) => IApiResponse | IApiReference)): OpenApiDecorator;
export declare function ApiCallback(key: string, callback: IApiCallback | IApiReference | ((controller: any) => IApiCallback | IApiReference)): OpenApiDecorator;
export declare function ApiDeprecated(deprecated?: boolean | ((controller: any) => boolean)): OpenApiDecorator;
export declare function ApiDefineSchema(key: string, schema: IApiSchema | IApiReference | ((controller: any) => IApiSchema | IApiReference)): OpenApiDecorator;
export declare function ApiDefineResponse(key: string, response: IApiResponse | IApiReference | ((controller: any) => IApiResponse | IApiReference)): OpenApiDecorator;
export declare function ApiDefineParameter(key: string, parameter: IApiParameter | IApiReference | ((controller: any) => IApiParameter | IApiReference)): OpenApiDecorator;
export declare function ApiDefineExample(key: string, example: IApiExample | IApiReference | ((controller: any) => IApiExample | IApiReference)): OpenApiDecorator;
export declare function ApiDefineRequestBody(key: string, requestBody: IApiRequestBody | IApiReference | ((controller: any) => IApiRequestBody | IApiReference)): OpenApiDecorator;
export declare function ApiDefineHeader(key: string, header: IApiHeader | IApiReference | ((controller: any) => IApiHeader | IApiReference)): OpenApiDecorator;
export declare function ApiDefineSecurityScheme(key: string, securityScheme: IApiSecurityScheme | IApiReference | ((controller: any) => IApiSecurityScheme | IApiReference)): OpenApiDecorator;
export declare function ApiDefineLink(key: string, link: IApiLink | IApiReference | ((controller: any) => IApiLink | IApiReference)): OpenApiDecorator;
export declare function ApiDefineCallback(key: string, callback: IApiCallback | IApiReference | ((controller: any) => IApiCallback | IApiReference)): OpenApiDecorator;