Package org.opencastproject.util.doc.rest

Annotation Interface RestQuery

@Retention(RUNTIME) @Target(METHOD) public @interface RestQuery
This annotation type is used for annotating RESTful query(each java method, instead of the class). This annotation type needs to be kept until runtime.

  • Element Details

    • name

      String name
      Returns:
      the name of the query.

    • description

      String description
      Returns:
      a description of the query.

    • returnDescription

      String returnDescription
      Returns:
      a description of what is returned.

    • responses

      RestResponse[] responses
      Returns:
      a list of possible responses from this query.

    • pathParameters

      RestParameter[] pathParameters
      Returns:
      a list of path parameters for this query.
      Default:
      {}

    • restParameters

      RestParameter[] restParameters
      Returns:
      a list of query parameters for this query.
      Default:
      {}

    • bodyParameter

      RestParameter bodyParameter
      Returns:
      a body parameter for this query.
      Default:
      @org.opencastproject.util.doc.rest.RestParameter(defaultValue="", description="", isRequired=false, name="", type=NO_PARAMETER)