net.ozwolf.raml.annotations

Annotation Type RamlResource

@Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface RamlResource

RAML Resource Annotation

Annotation used to describe a top-level resource class.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	description The description of the resource’s purpose
String	displayName The display name for the resource

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
int	displayOrder Define a display order for your documentation.

Element Detail

displayName

public abstract String displayName

The display name for the resource

Returns:

the resource display name

description

public abstract String description

The description of the resource’s purpose

Returns:

the resource description

displayOrder

public abstract int displayOrder

Define a display order for your documentation.

If resources are found with the same display order, they will be sorted alphabetically in the API docs view.

Returns:

the resource display order

Default:

999999