api-morph / ResponseObject

Interface: ResponseObject

Defined in: src/types/openapi.ts:779

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/v3.1.1#response-object

Indexable

[key: `x-${string}`]: any

This object MAY be extended with Specification Extensions.

Properties

content?

optional content: Record<string, MediaTypeObject>

Defined in: src/types/openapi.ts:796

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

Defined in: src/types/openapi.ts:783

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

---

headers?

optional headers: Record<string, ReferenceObject | HeaderObject>

Defined in: src/types/openapi.ts:789

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.

---

links?

optional links: Record<string, ReferenceObject | LinkObject>

Defined in: src/types/openapi.ts:802

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.