Interface ResponseObject

Describes a single response from an API Operation, including design-time, static links to operations based on the response.

See

https://spec.openapis.org/oas/latest.html#response-object

interface ResponseObject {
    content?: Record<string, MediaTypeObject>;
    description: string;
    headers?: Record<string, ReferenceObject | HeaderObject>;
    links?: Record<string, ReferenceObject | AnyLinkObject>;
}

Hierarchy (view full)

Properties

content? description headers? links?

Properties

Optional content

content?: Record<string, MediaTypeObject>

A map containing descriptions of potential response payloads. The key is a media type or media type range and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/*

description

description: string

A description of the response. CommonMark syntax MAY be used for rich text representation.

Optional headers

headers?: Record<string, ReferenceObject | HeaderObject>

Maps a header name to its definition. [RFC7230] states header names are case insensitive. If a response header is defined with the name "Content-Type", it SHALL be ignored.

Optional links

links?: Record<string, ReferenceObject | AnyLinkObject>

A map of operations links that can be followed from the response. The key of the map is a short name for the link, following the naming constraints of the names for Component Objects.

Settings

Member Visibility

Theme

On This Page

contentdescriptionheaderslinks