Package org.apache.camel.spi
Annotation Type ApiParam
-
@Retention(RUNTIME) @Documented @Target(FIELD) public @interface ApiParam
Used for annotating aUriParamparameter 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
Required Elements Modifier and Type Required Element Description ApiMethod[]apiMethodsThe API methods that the API provides of this configuration class.
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description StringdescriptionReturns a description of this parameter.booleanoptionalWhether the parameter is optional (in some rare circumstances the parameter may be required)
-