import { EntityDescriptor, RelationshipDef } from "../../common/interfaces/entity.schema.interface"; /** * Options for @ApiJsonApiResponse decorator. */ export interface ApiJsonApiResponseOptions { /** If true, documents a collection response instead of single resource */ isList?: boolean; /** HTTP status code (default: 200 for GET, 201 for POST) */ status?: number; /** Custom description */ description?: string; /** If true, response is 204 No Content */ noContent?: boolean; } /** * Decorator that documents a JSON:API response for an endpoint. * Automatically generates the correct response schema based on EntityDescriptor. * * @example * // Single resource response * @ApiJsonApiResponse(PhotographDescriptor) * @Get(':id') * findById() { ... } * * @example * // Collection response * @ApiJsonApiResponse(PhotographDescriptor, { isList: true }) * @Get() * findAll() { ... } * * @example * // Created response * @ApiJsonApiResponse(PhotographDescriptor, { status: 201 }) * @Post() * create() { ... } */ export declare function ApiJsonApiResponse>(descriptor: EntityDescriptor, options?: ApiJsonApiResponseOptions): MethodDecorator; //# sourceMappingURL=api-jsonapi-response.decorator.d.ts.map