RequestBody
in package
implements
OpenApiAttributeInterface
The attribute may be used on a method parameter to define it as the Request Body of the operation, and/or to define additional properties for such request body.
Interfaces, Classes, Traits and Enums
Table of Contents
- $content : array<string|int, mixed>
- $description : string
- $extensions : array<string|int, mixed>
- $ref : string
- $required : bool
- __construct() : mixed
Properties
$content
public
array<string|int, mixed>
$content
= []
$description
public
string
$description
= ""
$extensions
public
array<string|int, mixed>
$extensions
= []
$ref
public
string
$ref
= ""
$required
public
bool
$required
= false
Methods
__construct()
public
__construct([string $description = "" ][, array<string|int, Content> $content = [] ][, bool $required = false ][, array<string|int, Extension> $extensions = [] ][, string $ref = "" ]) : mixed
Parameters
- $description : string = ""
-
A brief description of the request body.
- $content : array<string|int, Content> = []
-
The content of the request body.
- $required : bool = false
-
Determines if the request body is required in the request. Defaults to false.
- $extensions : array<string|int, Extension> = []
-
The list of optional extensions
- $ref : string = ""
-
A reference to a RequestBody defined in components RequestBodies.