Describes a single request body.

interface RequestBodyObject {
    content: Record<string, MediaTypeObject>;
    description?: string;
    required?: boolean;
}

Hierarchy (view full)

Properties

content: Record<string, MediaTypeObject>

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?: string

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

required?: boolean

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