@Metadata(label="rest") public class RestOperationParamDefinition extends Object
Constructor and Description |
---|
RestOperationParamDefinition() |
RestOperationParamDefinition(VerbDefinition verb) |
Modifier and Type | Method and Description |
---|---|
RestOperationParamDefinition |
access(String paramAccess)
Deprecated.
is not in use in swagger specification 2.0
|
RestOperationParamDefinition |
allowableValues(List<String> allowableValues)
Allowed values of the parameter when its an enum type
|
RestOperationParamDefinition |
allowableValues(String... allowableValues)
Allowed values of the parameter when its an enum type
|
RestOperationParamDefinition |
arrayType(String arrayType)
The data type of the array data type
|
RestOperationParamDefinition |
collectionFormat(CollectionFormat collectionFormat)
Sets the collection format.
|
RestOperationParamDefinition |
dataFormat(String type)
The data format of the parameter such as binary, date, date-time, password.
|
RestOperationParamDefinition |
dataType(String type)
The data type of the parameter such as string, integer, boolean
|
RestOperationParamDefinition |
defaultValue(String name)
The default value of the parameter.
|
RestOperationParamDefinition |
description(String name)
Description of the parameter.
|
RestDefinition |
endParam()
Ends the configuration of this parameter
|
RestOperationParamDefinition |
example(String example)
Adds a single example
|
RestOperationParamDefinition |
example(String contentType,
String example)
Adds a body example with the given content-type
|
String |
getAccess()
Deprecated.
is not in use in swagger specification 2.0
|
List<String> |
getAllowableValues() |
String |
getArrayType() |
CollectionFormat |
getCollectionFormat() |
String |
getDataFormat() |
String |
getDataType() |
String |
getDefaultValue()
Sets the Swagger Parameter default value.
|
String |
getDescription() |
List<RestPropertyDefinition> |
getExamples() |
String |
getName() |
Boolean |
getRequired() |
RestParamType |
getType() |
RestOperationParamDefinition |
name(String name)
Name of the parameter.
|
RestOperationParamDefinition |
required(Boolean required)
Whether the parameter is required
|
void |
setAccess(String access)
Deprecated.
is not in use in swagger specification 2.0
|
void |
setAllowableValues(List<String> allowableValues)
Sets the Swagger Parameter list of allowable values (enum).
|
void |
setArrayType(String arrayType)
Sets the Swagger Parameter array type.
|
void |
setCollectionFormat(CollectionFormat collectionFormat)
Sets the Swagger Parameter collection format.
|
void |
setDataFormat(String dataFormat)
Sets the Swagger Parameter data format.
|
void |
setDataType(String dataType)
Sets the Swagger Parameter data type.
|
void |
setDefaultValue(String defaultValue) |
void |
setDescription(String description)
Sets the Swagger Parameter description.
|
void |
setExamples(List<RestPropertyDefinition> examples)
Sets the Swagger Parameter examples.
|
void |
setName(String name)
Sets the Swagger Parameter name.
|
void |
setRequired(Boolean required)
Sets the Swagger Parameter required flag.
|
void |
setType(RestParamType type)
Sets the Swagger Parameter type.
|
RestOperationParamDefinition |
type(RestParamType type)
The parameter type such as body, form, header, path, query
|
public RestOperationParamDefinition()
public RestOperationParamDefinition(VerbDefinition verb)
public RestParamType getType()
public void setType(RestParamType type)
public String getDescription()
public void setDescription(String description)
public String getDefaultValue()
public void setDefaultValue(String defaultValue)
public Boolean getRequired()
public void setRequired(Boolean required)
public CollectionFormat getCollectionFormat()
public void setCollectionFormat(CollectionFormat collectionFormat)
public String getArrayType()
public void setArrayType(String arrayType)
public String getDataType()
public void setDataType(String dataType)
public String getDataFormat()
public void setDataFormat(String dataFormat)
public List<String> getAllowableValues()
public void setAllowableValues(List<String> allowableValues)
@Deprecated public String getAccess()
@Deprecated public void setAccess(String access)
public List<RestPropertyDefinition> getExamples()
public void setExamples(List<RestPropertyDefinition> examples)
public RestOperationParamDefinition name(String name)
public RestOperationParamDefinition description(String name)
public RestOperationParamDefinition defaultValue(String name)
public RestOperationParamDefinition required(Boolean required)
public RestOperationParamDefinition collectionFormat(CollectionFormat collectionFormat)
public RestOperationParamDefinition arrayType(String arrayType)
public RestOperationParamDefinition dataType(String type)
public RestOperationParamDefinition dataFormat(String type)
public RestOperationParamDefinition allowableValues(List<String> allowableValues)
public RestOperationParamDefinition allowableValues(String... allowableValues)
public RestOperationParamDefinition type(RestParamType type)
@Deprecated public RestOperationParamDefinition access(String paramAccess)
public RestOperationParamDefinition example(String contentType, String example)
public RestOperationParamDefinition example(String example)
public RestDefinition endParam()
Apache Camel