Annotation Type RestRequest
@Documented
@Target(METHOD)
@Retention(SOURCE)
public @interface RestRequest
Used to describe the Request Body for REST resources which accept
input using the entire body without specifically indexed parameter names.
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description java.lang.String
description
Description of the request.RestObjectProperty[]
properties
Array ofRestObjectProperty
of properties contained in a root JSON in this request.java.lang.String
sampleValue
Sample Value of the request body.
-
Element Details
-
description
java.lang.String descriptionDescription of the request.
Optional.
Default Value - "No description available."- Default:
- "No description available"
-
sampleValue
java.lang.String sampleValueSample Value of the request body.
Optional.
Default Value - "No sample value available."- Default:
- "No sample value available"
-
properties
RestObjectProperty[] propertiesArray ofRestObjectProperty
of properties contained in a root JSON in this request.
Optional.
Default Value - Empty array.- Default:
- {}
-