1 /*
2 * The contents of this file are subject to the terms of the Common Development and
3 * Distribution License (the License). You may not use this file except in compliance with the
4 * License.
5 *
6 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
7 * specific language governing permission and limitations under the License.
8 *
9 * When distributing Covered Software, include this CDDL Header Notice in each file and include
10 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
11 * Header, with the fields enclosed by brackets [] replaced by your own identifying
12 * information: "Portions copyright [year] [name of copyright owner]".
13 *
14 * Copyright 2016 ForgeRock AS.
15 */
16
17 package org.forgerock.api.annotations;
18
19 import java.lang.annotation.ElementType;
20 import java.lang.annotation.Retention;
21 import java.lang.annotation.RetentionPolicy;
22 import java.lang.annotation.Target;
23
24 /**
25 * Annotation to define JSON Schema property's description. This annotation is equal to
26 * {@link com.fasterxml.jackson.annotation.JsonPropertyDescription}, but has the added benefit of being scoped
27 * as a {@link ElementType#TYPE} annotation, for describing an entire class-model.
28 */
29 @Retention(RetentionPolicy.RUNTIME)
30 @Target({ElementType.FIELD, ElementType.METHOD, ElementType.TYPE})
31 public @interface Description {
32 /**
33 * The description of the property.
34 */
35 String value();
36 }