Package com.onenetwork.platform.integ.rest.annotation

Annotation Type RestParam

@Documented
@Target(PARAMETER)
@Retention(SOURCE)
public @interface RestParam
Used to document QueryParam, PathParam or FormParam.
Cannot be used alone. It should be used along with the above mentioned JAX-RS specification annotations.

  • Optional Element Summary

    Optional Elements 
    Modifier and Type Optional Element Description
    java.lang.String description
    Description for the RestParam.
    Optional.
    Default Value - "No description available."
    boolean required
    Specifies if the annotated RestParam is required or optional.
    java.lang.String sampleValue
    Sample Value for the annotated RestParam.

  • Element Details

    • description

      java.lang.String description
      Description for the RestParam.
      Optional.
      Default Value - "No description available."
      Default:
      "No description available"

    • required

      boolean required
      Specifies if the annotated RestParam is required or optional. Not enforced at runtime, informational only.
      Optional.
      Default Value - true.
      Default:
      true

    • sampleValue

      java.lang.String sampleValue
      Sample Value for the annotated RestParam.
      Optional.
      Default Value - "No sample value available."
      Default:
      "No sample value available"