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

Annotation Type RestResponse

@Documented
@Target(METHOD)
@Retention(SOURCE)
public @interface RestResponse
Used to describe the Response Body for a REST resource.

  • Element Details

    • description

      java.lang.String description
      Description of the response.
      Optional.
      Default Value - "No description available."
      Default:
      "No description available"

    • sampleValue

      java.lang.String sampleValue
      Sample Value of the response body.
      Optional.
      Default Value - "No sample value available."
      Default:
      "No sample value available"

    • properties

      RestObjectProperty[] properties
      Array of RestObjectProperty of properties contained in a root JSON in this response.
      Optional.
      Default Value - Empty array.
      Default:
      {}