Interface OS3RequestBody

# Interface OS3RequestBody

Interface
Module
import { OS3RequestBody } from "@tsed/openspec"
Source/packages/specs/openspec/src/types/openspec3/OS3RequestBody.ts

# Overview

interface OS3RequestBody<Schema = OS3Schema> {

description?<span class="token punctuation">:</span> <span class="token keyword">string</span><span class="token punctuation">;</span>

content?<span class="token punctuation">:</span> <a href="/api/specs/openspec/types/common/OpenSpecHash.html"><span class="token">OpenSpecHash</span></a>&lt;<a href="/api/specs/openspec/types/openspec3/OS3MediaType.html"><span class="token">OS3MediaType</span></a>&lt;<a href="/api/orm/mongoose/types/decorators/Schema.html"><span class="token">Schema</span></a>&gt;&gt;<span class="token punctuation">;</span>

required?<span class="token punctuation">:</span> <span class="token keyword">boolean</span><span class="token punctuation">;</span>
examples?<span class="token punctuation">:</span> <a href="/api/specs/openspec/types/common/OpenSpecHash.html"><span class="token">OpenSpecHash</span></a>&lt;<a href="/api/specs/openspec/types/openspec3/OS3Example.html"><span class="token">OS3Example</span></a> | <a href="/api/specs/openspec/types/common/OpenSpecRef.html"><span class="token">OpenSpecRef</span></a>&gt;<span class="token punctuation">;</span>

}

# Members

description?: string;

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

content?: OpenSpecHash<OS3MediaType<Schema>>;

A map containing descriptions of potential request body. 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/*

required?: boolean;

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