Skip to content

Latest commit

 

History

History
44 lines (24 loc) · 1.14 KB

File metadata and controls

44 lines (24 loc) · 1.14 KB

api-typescript-generator / Modules / openapi / OpenApiRequestBody

Interface: OpenApiRequestBody

openapi.OpenApiRequestBody

Describes a single request body.

See

https://swagger.io/specification/#request-body-object

Table of contents

Properties

Properties

content

content: Record<string, OpenApiMediaType>

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

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


required

Optional required: boolean

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