ErrorOpenApiResponse: {
    description?: string;
    status?: HttpStatus;
    type: "error";
}

Descriptor for an error response:

  • type: 'error'
  • optional HTTP status and description.

Type declaration

  • Optionaldescription?: string

    Human-readable description of the error.

  • Optionalstatus?: HttpStatus

    HTTP status code to use for the error response.

  • type: "error"

    Constant identifier for an error response.