Package org.forgerock.api.annotations

Annotation Interface Example

@Retention(RUNTIME) @Target({FIELD,TYPE}) public @interface Example
Specify an example value for the JSON schema.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    value
    String representation of the example.

  • Element Details

    • value

      String value
      String representation of the example. If the value should be loaded from a classpath resource, prefix with classpath:.