001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2016 ForgeRock AS.
015 */
016
017package org.forgerock.api.annotations;
018
019import java.lang.annotation.ElementType;
020import java.lang.annotation.Retention;
021import java.lang.annotation.RetentionPolicy;
022import java.lang.annotation.Target;
023
024/**
025 * Annotation to define JSON Schema property's description. This annotation is equal to
026 * {@link com.fasterxml.jackson.annotation.JsonPropertyDescription}, but has the added benefit of being scoped
027 * as a {@link ElementType#TYPE} annotation, for describing an entire class-model.
028 */
029@Retention(RetentionPolicy.RUNTIME)
030@Target({ElementType.FIELD, ElementType.METHOD, ElementType.TYPE})
031public @interface Description {
032    /**
033     * The description of the property.
034     */
035    String value();
036}