Interface IResponse

Response definition.

interface IResponse {
    content?: Record<string, OpenApiV3.IOperation.IMediaType>;
    description?: string;
    headers?: Record<
        string,
        | OpenApiV3.IJsonSchema.IReference<`#/components/headers/${string}`>
        | Omit<OpenApiV3.IOperation.IParameter, "in">,
    >;
}

Index

Properties

content? description? headers?

Properties

`Optional`content

content?: Record<string, OpenApiV3.IOperation.IMediaType>

Response content by media type.

`Optional`description

description?: string

Response description.

`Optional`headers

headers?: Record<
    string,
    | OpenApiV3.IJsonSchema.IReference<`#/components/headers/${string}`>
    | Omit<OpenApiV3.IOperation.IParameter, "in">,
>

Response headers.