FileOpenApiResponse: {
    description?: string;
    mimeType?: "all" | MimeType | MimeType[];
    status?: HttpStatus;
    type: "file";
}

Descriptor for a file response in OpenAPI:

  • type: 'file'
  • optional HTTP status, description, and mimeType(s).

Type declaration

  • Optionaldescription?: string

    Human-readable description of the file response.

  • OptionalmimeType?: "all" | MimeType | MimeType[]

    Allowed MIME type(s) for the file response ('all' for any or one/multiple specific types).

  • Optionalstatus?: HttpStatus

    HTTP status code to use for the file response.

  • type: "file"

    Constant identifier for a file response.