net.ozwolf.raml.annotations

Annotation Type RamlDescribedBy

@Retention(value=RUNTIME)
public @interface RamlDescribedBy

RAML Described by Annotation

An annotation used to provide a describedBy definition for security schemes and traits.

See Also:

RamlSecurityScheme, RamlTrait

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
RamlParameter[]	headers The headers associated with the descriptor.
RamlParameter[]	queryParameters The query parameters associated with the descriptor.
RamlResponse[]	responses The responses associated with the descriptor

Element Detail

headers

public abstract RamlParameter[] headers

The headers associated with the descriptor.

Returns:

the descriptor headers

Default:

{}

queryParameters

public abstract RamlParameter[] queryParameters

The query parameters associated with the descriptor.

Returns:

the descriptor query parameters

Default:

{}

responses

public abstract RamlResponse[] responses

The responses associated with the descriptor

Returns:

the descriptor responses

Default:

{}