net.ozwolf.raml.annotations

Annotation Type RamlResponse

@Retention(value=RUNTIME)
public @interface RamlResponse

RAML Response Annotation

An annotation used to describe a response in greater detail.

The generator can generate response information based purely on the signature of methods. However, this will assume 200 response codes and will miss any other response codes that may be returned.

Used in conjunction with the @RamlResponses annotation.

See Also:

RamlResponse

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	description The description of what the response represents
int	status The status code of the response

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
RamlBody[]	bodies The body payloads that would be returned based on the use of the Accept request header.
RamlParameter[]	headers The headers that would be included in the response.

Element Detail

status

public abstract int status

The status code of the response

Returns:

the status code

description

public abstract String description

The description of what the response represents

Returns:

the description

headers

public abstract RamlParameter[] headers

The headers that would be included in the response.

Returns:

the response headers

Default:

{}

bodies

public abstract RamlBody[] bodies

The body payloads that would be returned based on the use of the Accept request header.

Returns:

the response bodies

Default:

{}