Package org.apache.camel.spi
Annotation Interface ApiParam
Used for annotating a
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.-
Required Element Summary
Modifier and TypeRequired ElementDescriptionThe API methods that the API provides of this configuration class. -
Optional Element Summary
Modifier and TypeOptional ElementDescriptionReturns a description of this parameter.boolean
Whether the parameter is optional (in some rare circumstances the parameter may be required)
-
Element Details
-
apiMethods
ApiMethod[] apiMethodsThe API methods that the API provides of this configuration class.
-
-
-
optional
boolean optionalWhether the parameter is optional (in some rare circumstances the parameter may be required)- Default:
- false
-
description
String descriptionReturns a description of this parameter. This is used for documentation and tooling only.- Default:
- ""
-