org.jsondoc.core.annotation

Annotation Type ApiHeader

@Documented
 @Target(value={ANNOTATION_TYPE,PARAMETER})
 @Retention(value=RUNTIME)
public @interface ApiHeader

This annotation is to be used inside an annotation of type ApiHeaders

Author:

Fabio Maffioletti

See Also:

ApiHeaders

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	allowedvalues An array representing the allowed values this header can have.
String	description A description of what the header is needed for
String	name The name of the header parameter

Element Detail

name

public abstract String name

The name of the header parameter

Returns:

Default:

""

description

public abstract String description

A description of what the header is needed for

Returns:

Default:

""

allowedvalues

public abstract String[] allowedvalues

An array representing the allowed values this header can have. Default value is *

Returns:

Default:

{}