Package io.micronaut.jsonschema

Annotation Interface JsonSchema

@Target({TYPE,FIELD}) public @interface JsonSchema
An annotation that signifies that json schema should be created for the object. The JSON schema will attempt to mimic the way this object would be serialized.
Since:
1.0.0
Author:
Andriy Dmytruk

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    description
    The description of the JSON schema.
    String
    title
    The title of the JSON schema.
    String
    uri
    The schema's relative or absolute URI.

  • Element Details

    • title

      String title
      The title of the JSON schema. By default, the class name will be used.
      Returns:
      The title
      Default:
      ""

    • description

      String description
      The description of the JSON schema. By default, javadoc of the object will be used.
      Returns:
      The description
      Default:
      ""

    • uri

      String uri
      The schema's relative or absolute URI. The default will create the URI based on class name and configured base URI.
      Returns:
      The URI
      Default:
      ""