api-morph / RequestBodyObject

Interface: RequestBodyObject

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

Describes a single request body.

See

https://spec.openapis.org/oas/v3.1.1#request-body-object

Indexable

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

This object MAY be extended with Specification Extensions.

Properties

content

content: Record<string, MediaTypeObject>

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

REQUIRED. The content of the request body. The key is a media type or media type range and the value describes it. For requests that match multiple keys, only the most specific key is applicable. e.g. "text/plain" overrides "text/*"

---

description?

optional description: string

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

A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.

---

required?

optional required: boolean

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

Determines if the request body is required in the request. Defaults to false.