org.forgerock.api.annotations

Annotation Type Description

@Retention(value=RUNTIME)
 @Target(value={FIELD,METHOD,TYPE})
public @interface Description

Annotation to define JSON Schema property's description. This annotation is equal to JsonPropertyDescription, but has the added benefit of being scoped as a ElementType.TYPE annotation, for describing an entire class-model.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value The description of the property.

Element Detail

value

public abstract String value

The description of the property.