Annotation Type ApiParam


  • @Retention(RUNTIME)
    @Documented
    @Target(FIELD)
    public @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

      Required Elements 
      Modifier and Type Required Element Description
      ApiMethod[] apiMethods
      The API methods that the API provides of this configuration class.
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element 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)
    • Element Detail

      • apiMethods

        ApiMethod[] apiMethods
        The API methods that the API provides of this configuration class.
      • optional

        boolean optional
        Whether the parameter is optional (in some rare circumstances the parameter may be required)
        Default:
        false
      • description

        String description
        Returns a description of this parameter.

        This is used for documentation and tooling only.

        Default:
        ""