Type Alias JsonOpenApiResponse

Descriptor for a JSON response in OpenAPI:

type JsonOpenApiResponse = {
    cls?: Newable<unknown>;
    description?: string;
    isArray?: boolean;
    status?: HttpStatus;
    type: "json";
}

Properties

cls?: Newable<unknown>

Constructor function to map the JSON payload to a class instance.

description?: string

Human-readable description of the JSON response.

isArray?: boolean

If true, indicates the response payload is an array of items.

HTTP status code to use for the JSON response.

type: "json"

Constant identifier for a JSON response.