Module com.fasterxml.jackson.annotation
Package com.fasterxml.jackson.annotation

Annotation Interface JsonPropertyDescription

@Target({ANNOTATION_TYPE,FIELD,METHOD,PARAMETER}) @Retention(RUNTIME) @Documented public @interface JsonPropertyDescription
Annotation used to define a human-readable description for a logical property. Currently used to populate the description field in generated JSON Schemas.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    value
    Defines a human-readable description of the logical property.

  • Element Details

    • value

      String value
      Defines a human-readable description of the logical property. Currently used to populate the description field in generated JSON Schemas.
      Default:
      ""