net.ozwolf.raml.annotations

Annotation Type RamlTrait

@Retention(value=RUNTIME)
public @interface RamlTrait

RAML Trait Annotation

A way to describe a particular trait, including request headers, query parameters and responses.

This can then be referenced using the @RamlIs annotation on resource methods, allowing those methods to inherit the defined trait.

See Also:

RamlIs

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
RamlDescribedBy	describedBy The overall descriptor of the trait, covering required headers, query parameters and associated responses.
String	key The trait key that is used by the @RamlIs annotation.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	description Describe the trait
String	usage Describe the usage situation of the trait

Element Detail

key

public abstract String key

The trait key that is used by the @RamlIs annotation.

Returns:

the trait key

describedBy

public abstract RamlDescribedBy describedBy

The overall descriptor of the trait, covering required headers, query parameters and associated responses.

Returns:

the trait descriptor

usage

public abstract String usage

Describe the usage situation of the trait

Returns:

the trait usage

Default:

""

description

public abstract String description

Describe the trait

Returns:

the trait description

Default:

""