[T] OpenAPI3RequestBody
type OpenAPI3RequestBody = Extensions & object;
Describes a single request body.
Type declaration
Name | Type | Description |
---|---|---|
content | Record <string , OpenAPI3MediaType > | 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. |
See
https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#request-body-object