water.schemas

Annotation Type API

@Retention(value=RUNTIME)
@Target(value=FIELD)
@Documented
public @interface API

API Annotation API annotations are used to document *input field* behaviors for the external REST API. Each input field to some web page is described by a matching Java field, plus these annotations.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	help

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String[]	dependsOn
java.lang.String	validation
java.lang.String	values

Element Detail

help

public abstract java.lang.String help

dependsOn

public abstract java.lang.String[] dependsOn

Default:

{}

validation

public abstract java.lang.String validation

Default:

""

values

public abstract java.lang.String values

Default:

""