Annotation Type WebApiParam


@Target(METHOD) @Retention(RUNTIME) public @interface WebApiParam
A parameter used on a resource method operation in the Rest API The parameter kind is one of : QUERY_STRING - A query string parameter as part of the URL HTTP_BODY_OBJECT - A JSON object specified in a HTTP_BODY used by either a POST or PUT URL_PATH - Included as part of the actual url, e.g. entity id. (Does not support multiple values) HTTP_HEADER - Included in the request's HTTP Header
Author:
Gethin James
  • Element Details

    • description

      String description
      Default:
      ""
    • required

      boolean required
      Default:
      false
    • kind

      Default:
      URL_PATH
    • allowMultiple

      boolean allowMultiple
      Default:
      true