001// ***************************************************************************************************************************
002// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
003// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
004// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance            *
005// * with the License.  You may obtain a copy of the License at                                                              *
006// *                                                                                                                         *
007// *  http://www.apache.org/licenses/LICENSE-2.0                                                                             *
008// *                                                                                                                         *
009// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an  *
010// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the        *
011// * specific language governing permissions and limitations under the License.                                              *
012// ***************************************************************************************************************************
013package org.apache.juneau.jsonschema.annotation;
014
015import static java.lang.annotation.ElementType.*;
016import static java.lang.annotation.RetentionPolicy.*;
017
018import java.lang.annotation.*;
019
020import org.apache.juneau.json.*;
021
022/**
023 * Annotation for specifying various JSON-SCHEMA information for {@link JsonSchemaSerializer}.
024 *
025 * <p>
026 * Can be applied to Java types and bean methods/fields.
027 */
028@Documented
029@Target({TYPE,METHOD,FIELD})
030@Retention(RUNTIME)
031@Inherited
032public @interface JsonSchema {
033
034   /**
035    * Defines the type for the class or property.
036    */
037   String type() default "";
038
039   /**
040    * Defines the format for the class or property.
041    */
042   String format() default "";
043
044   /**
045    * Defines the description for the class or property.
046    */
047   String description() default "";
048
049   /**
050    * Defines the example for the class or property.
051    *
052    * <p>
053    * The format of the value is Lax-JSON.
054    */
055   String example() default "";
056}