com.apporiented.rest.apidoc.annotation

Annotation Type ApiParamDoc

@Documented
 @Target(value=PARAMETER)
 @Retention(value=RUNTIME)
public @interface ApiParamDoc

Description of a REST resource parameter.

Author:

Fabio Maffioletti, Lars Behnke

See Also:

ApiParamDocModel

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	allowedValues
String	dataType
Class<? extends Enum>	enumClass Intended for REST interfaces that accept string values as parameters, which are mapped to enum types by the application.
String	format
String	value

Element Detail

value

public abstract String value

Default:

""

allowedValues

public abstract String[] allowedValues

Default:

{}

enumClass

public abstract Class<? extends Enum> enumClass

Intended for REST interfaces that accept string values as parameters, which are mapped to enum types by the application.

Returns:

The enum class

Default:

com.apporiented.rest.apidoc.annotation.ApiParamDoc.EmptyEnum.class

format

public abstract String format

Default:

""

dataType

public abstract String dataType

Default:

""