org.restdoc.annotations

Annotation Type RestDocParam

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

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
RestDocValidation[]	validations

Element Detail

description

public abstract String description

Returns:

the description of the parameter

validations

public abstract RestDocValidation[] validations

Returns:

the parameter validations

Default:

{}