(Quick Reference)
ApiImplicitParam
Purpose
Documents a param for an operation
Usage
@ApiImplicitParam(name="", value="", defaultValue="", allowableValues="", required=false, access="",
allowMultiple=false, dataType="", paramType="")Parameters
| Parameter | Supported | Usage |
|---|
name | Yes | The name for the parameter. If paramType is "path", the name should be the associated section in the path. If paramType is "body", the name should be "body". |
value | Yes | A brief description of the parameter. |
defaultValue | Yes | Describes the default value for the parameter. |
allowableValues | Yes | Limits the acceptable values for this parameter. To set a list of values, provide a comma-separated list surrounded by square brackets. |
required | Yes | Specifies if the parameter is required or not. |
access | No | Allows for filtering a parameter from the API documentation. |
allowMultiple | Yes | Specifies whether the parameter can accept multiple comma-separated values. |
dataType | Yes | The data type of the parameter. This can be the class name or a primitive. |
paramType | Yes | The parameter type of the parameter. Valid values are path, query, body, header or form. |