1 package com.fasterxml.jackson.annotation;
2 
3 import java.lang.annotation.Documented;
4 import java.lang.annotation.ElementType;
5 import java.lang.annotation.Retention;
6 import java.lang.annotation.RetentionPolicy;
7 import java.lang.annotation.Target;
8 
9 /**
10  * Annotation used to define a human readable description for a logical
11  * property.
12  * Currently used to populate the description field in generated JSON
13  * Schemas.
14  *
15  * @since 2.3
16  */
17 @Target({ElementType.ANNOTATION_TYPE, ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER})
18 @Retention(RetentionPolicy.RUNTIME)
19 @Documented // since 2.6
20 @JacksonAnnotation
21 public @interface JsonPropertyDescription
22 {
23     /**
24      * Defines a human readable description of the logical property.
25      * Currently used to populate the description field in generated JSON
26      * Schemas.
27      */
value()28     String value() default "";
29 }
30