ParamDefinition |
ParamDefinition.allowableValues(String allowableValues) |
Allowed values of the parameter when its an enum type
|
ParamDefinition |
ParamDefinition.allowableValues(String... allowableValues) |
Allowed values of the parameter when its an enum type
|
ParamDefinition |
ParamDefinition.allowableValues(List<String> allowableValues) |
Allowed values of the parameter when its an enum type
|
ParamDefinition |
ParamDefinition.arrayType(String arrayType) |
The data type of the array data type
|
ParamDefinition |
ParamDefinition.collectionFormat(CollectionFormat collectionFormat) |
Sets the collection format.
|
ParamDefinition |
ParamDefinition.dataFormat(String type) |
The data format of the parameter such as binary, date, date-time, password.
|
ParamDefinition |
ParamDefinition.dataType(String type) |
The data type of the parameter such as string, integer, boolean
|
ParamDefinition |
ParamDefinition.defaultValue(String name) |
The default value of the parameter.
|
ParamDefinition |
ParamDefinition.description(String name) |
Description of the parameter.
|
ParamDefinition |
ParamDefinition.example(String example) |
Adds a single example
|
ParamDefinition |
ParamDefinition.example(String contentType,
String example) |
Adds a body example with the given content-type
|
ParamDefinition |
ParamDefinition.name(String name) |
Name of the parameter.
|
ParamDefinition |
RestDefinition.param() |
|
ParamDefinition |
RestDefinition.param(VerbDefinition verb) |
|
ParamDefinition |
ParamDefinition.required(Boolean required) |
Whether the parameter is required
|
ParamDefinition |
ParamDefinition.type(RestParamType type) |
The parameter type such as body, form, header, path, query
|