@Retention(value=RUNTIME) @Documented @Target(value=FIELD) public @interface ApiParam
UriParam
parameter that its for use by API based endpoints.
The information from this annotation provides additional information such as which API method(s) the parameter
supports.Modifier and Type | Required Element and Description |
---|---|
ApiMethod[] |
apiMethods
The API methods that the API provides of this configuration class.
|
Modifier and Type | Optional Element and Description |
---|---|
String |
description
Returns a description of this parameter.
|
boolean |
optional
Whether the parameter is optional (in some rare circumstances the parameter may be required)
|
public abstract ApiMethod[] apiMethods
public abstract boolean optional
public abstract String description
Apache Camel