1 | import { Type } from '@nestjs/common';
|
2 | import { ResponseObject, SchemaObject, ReferenceObject } from '../interfaces/open-api-spec.interface';
|
3 | export interface ApiResponseMetadata extends Omit<ResponseObject, 'description'> {
|
4 | status?: number | 'default';
|
5 | type?: Type<unknown> | Function | [Function] | string;
|
6 | isArray?: boolean;
|
7 | description?: string;
|
8 | }
|
9 | export interface ApiResponseSchemaHost extends Omit<ResponseObject, 'description'> {
|
10 | schema: SchemaObject & Partial<ReferenceObject>;
|
11 | status?: number;
|
12 | description?: string;
|
13 | }
|
14 | export declare type ApiResponseOptions = ApiResponseMetadata | ApiResponseSchemaHost;
|
15 | export declare function ApiResponse(options: ApiResponseOptions): MethodDecorator & ClassDecorator;
|
16 | export declare const ApiOkResponse: (options?: ApiResponseOptions) => MethodDecorator & ClassDecorator;
|
17 | export declare const ApiCreatedResponse: (options?: ApiResponseOptions) => MethodDecorator & ClassDecorator;
|
18 | export declare const ApiAcceptedResponse: (options?: ApiResponseOptions) => MethodDecorator & ClassDecorator;
|
19 | export declare const ApiNoContentResponse: (options?: ApiResponseOptions) => MethodDecorator & ClassDecorator;
|
20 | export declare const ApiMovedPermanentlyResponse: (options?: ApiResponseOptions) => MethodDecorator & ClassDecorator;
|
21 | export declare const ApiFoundResponse: (options?: ApiResponseOptions) => MethodDecorator & ClassDecorator;
|
22 | export declare const ApiBadRequestResponse: (options?: ApiResponseOptions) => MethodDecorator & ClassDecorator;
|
23 | export declare const ApiUnauthorizedResponse: (options?: ApiResponseOptions) => MethodDecorator & ClassDecorator;
|
24 | export declare const ApiTooManyRequestsResponse: (options?: ApiResponseOptions) => MethodDecorator & ClassDecorator;
|
25 | export declare const ApiNotFoundResponse: (options?: ApiResponseOptions) => MethodDecorator & ClassDecorator;
|
26 | export declare const ApiInternalServerErrorResponse: (options?: ApiResponseOptions) => MethodDecorator & ClassDecorator;
|
27 | export declare const ApiBadGatewayResponse: (options?: ApiResponseOptions) => MethodDecorator & ClassDecorator;
|
28 | export declare const ApiConflictResponse: (options?: ApiResponseOptions) => MethodDecorator & ClassDecorator;
|
29 | export declare const ApiForbiddenResponse: (options?: ApiResponseOptions) => MethodDecorator & ClassDecorator;
|
30 | export declare const ApiGatewayTimeoutResponse: (options?: ApiResponseOptions) => MethodDecorator & ClassDecorator;
|
31 | export declare const ApiGoneResponse: (options?: ApiResponseOptions) => MethodDecorator & ClassDecorator;
|
32 | export declare const ApiMethodNotAllowedResponse: (options?: ApiResponseOptions) => MethodDecorator & ClassDecorator;
|
33 | export declare const ApiNotAcceptableResponse: (options?: ApiResponseOptions) => MethodDecorator & ClassDecorator;
|
34 | export declare const ApiNotImplementedResponse: (options?: ApiResponseOptions) => MethodDecorator & ClassDecorator;
|
35 | export declare const ApiPreconditionFailedResponse: (options?: ApiResponseOptions) => MethodDecorator & ClassDecorator;
|
36 | export declare const ApiPayloadTooLargeResponse: (options?: ApiResponseOptions) => MethodDecorator & ClassDecorator;
|
37 | export declare const ApiRequestTimeoutResponse: (options?: ApiResponseOptions) => MethodDecorator & ClassDecorator;
|
38 | export declare const ApiServiceUnavailableResponse: (options?: ApiResponseOptions) => MethodDecorator & ClassDecorator;
|
39 | export declare const ApiUnprocessableEntityResponse: (options?: ApiResponseOptions) => MethodDecorator & ClassDecorator;
|
40 | export declare const ApiUnsupportedMediaTypeResponse: (options?: ApiResponseOptions) => MethodDecorator & ClassDecorator;
|
41 | export declare const ApiDefaultResponse: (options?: ApiResponseOptions) => MethodDecorator & ClassDecorator;
|