Annotation Type RequestBody
-
@Target({PARAMETER,METHOD}) @Retention(RUNTIME) @Inherited public @interface RequestBody
Describes a single request body.- See Also:
- requestBody Object
-
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description Content[]
content
The content of the request body.String
description
A brief description of the request body.Extension[]
extensions
List of extensions to be added to theRequestBody
model corresponding to the containing annotation.String
name
The unique name to identify this request body.String
ref
Reference value to a RequestBody object.boolean
required
Determines if the request body is required in the request.
-
-
-
Element Detail
-
description
String description
A brief description of the request body.This could contain examples of use. CommonMark syntax MAY be used for rich text representation.
- Returns:
- description of this requestBody instance
- Default:
- ""
-
-
-
content
Content[] content
The content of the request body. It is a REQUIRED property unless this is only a reference to a request body instance.- Returns:
- content of this requestBody instance
- Default:
- {}
-
-
-
name
String name
The unique name to identify this request body. Unless this annotation is used on the actual request body parameter, it is required to match the name of that parameter so the appropriate association can be made. When the request body is defined withinComponents
. The name will be used as the key to add this request body to the 'requestBodies' map for reuse.- Returns:
- this request body's name
- Default:
- ""
-
-
-
ref
String ref
Reference value to a RequestBody object.This property provides a reference to an object defined elsewhere. This property and all other properties are mutually exclusive. If other properties are defined in addition to the ref property then the result is undefined.
- Returns:
- reference to a request body
- Default:
- ""
-
-
-
extensions
Extension[] extensions
List of extensions to be added to theRequestBody
model corresponding to the containing annotation.- Returns:
- array of extensions
- Since:
- 3.1
- Default:
- {}
-
-