Type Alias FileOpenApiResponse

Descriptor for a file response in OpenAPI:

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

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

Index

Properties

description? mimeType? status? type

Properties

`Optional`description

description?: string

Human-readable description of the file response.

`Optional`mimeType

mimeType?: "all" | MimeType | MimeType[]

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

`Optional`status

status?: HttpStatus

HTTP status code to use for the file response.

type

type: "file"

Constant identifier for a file response.