org.opencastproject.util.doc.rest

Annotation Type RestQuery

@Retention(value=RUNTIME)
 @Target(value=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.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	description
String	name
RestResponse[]	reponses
String	returnDescription

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
RestParameter	bodyParameter
RestParameter[]	pathParameters
RestParameter[]	restParameters

Element Detail

name

public abstract String name

Returns:

the name of the query.

description

public abstract String description

Returns:

a description of the query.

returnDescription

public abstract String returnDescription

Returns:

a description of what is returned.

reponses

public abstract RestResponse[] reponses

Returns:

a list of possible responses from this query.

pathParameters

public abstract RestParameter[] pathParameters

Returns:

a list of path parameters for this query.

Default:

{}

restParameters

public abstract RestParameter[] restParameters

Returns:

a list of query parameters for this query.

Default:

{}

bodyParameter

public abstract RestParameter bodyParameter

Returns:

a body parameter for this query.

Default:

@org.opencastproject.util.doc.rest.RestParameter(defaultValue="", description="", isRequired=false, name="", type=org.opencastproject.util.doc.rest.RestParameter.Type.NO_PARAMETER)