Interface IException

Metadata of response body for exceptional status cases.

interface IException {
    media: () => OpenApi.IOperation.IMediaType;
    response: () => OpenApi.IOperation.IResponse;
    schema: OpenApi.IJsonSchema;
}

Index

Properties

media response schema

Properties

media

media: () => OpenApi.IOperation.IMediaType

Media type of the response body.

response

response: () => OpenApi.IOperation.IResponse

Description comment for the exception.

schema

schema: OpenApi.IJsonSchema

Metadata of response body data type.