water.api

Annotation Type API

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

API Annotation API annotations are used to document field behaviors for the external REST API. Each field 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
API.Direction	direction
boolean	json
java.lang.String	label
API.Level	level
boolean	required
java.lang.String[]	validation
java.lang.String[]	values

Element Detail

help

public abstract java.lang.String help

label

public abstract java.lang.String label

Default:

""

required

public abstract boolean required

Default:

false

level

public abstract API.Level level

Default:

water.api.API.Level.critical

direction

public abstract API.Direction direction

Default:

water.api.API.Direction.INPUT

dependsOn

public abstract java.lang.String[] dependsOn

Default:

{}

validation

public abstract java.lang.String[] validation

Default:

{}

values

public abstract java.lang.String[] values

Default:

{}

json

public abstract boolean json

Default:

true