org.restdoc.annotations

Annotation Type RestDocHeader

@Target(value={PARAMETER,FIELD})
@Retention(value=RUNTIME)
public @interface RestDocHeader

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	description

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	name
boolean	required

Element Detail

description

public abstract String description

Returns:

the description of the header

required

public abstract boolean required

Returns:

if this header is mandatory

Default:

false

name

public abstract String name

Returns:

the name of this header if not already defined by javax.ws.rs.HeaderParam

Default:

""