net.ozwolf.raml.annotations

Annotation Type RamlSubResource

@Retention(value=RUNTIME)
public @interface RamlSubResource

RAML Sub-Resource Annotation

Used in conjunction with the @RamlSubResources annotation to describe sub-resource paths within a resource class.

If the sub-resource contains URI parameters, one of these annotations needs to be supplied to describe the URI parameters correctly.

See Also:

RamlSubResources

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
javax.ws.rs.Path	path The path the sub-resource maps to.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	description The description of the sub-resources purpose.
RamlParameter[]	uriParameters The URI parameters associated with the sub-resource path.

Element Detail

path

public abstract javax.ws.rs.Path path

The path the sub-resource maps to.

This path value should simply match the `@Path annotation on the associated method(s).

Returns:

the sub-resource path.

description

public abstract String description

The description of the sub-resources purpose.

Returns:

the sub-resource description

Default:

""

uriParameters

public abstract RamlParameter[] uriParameters

The URI parameters associated with the sub-resource path.

Returns:

the sub-resource URI parameters

Default:

{}