io.swagger.annotations.ApiModelProperty Maven / Gradle / Ivy
/**
* Copyright 2016 SmartBear Software
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.swagger.annotations;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Adds and manipulates data of a model property.
*/
@Target({ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface ApiModelProperty {
/**
* A brief description of this property.
*/
String value() default "";
/**
* Allows overriding the name of the property.
*
* @return the overridden property name
*/
String name() default "";
/**
* Limits the acceptable values for this parameter.
*
* There are three ways to describe the allowable values:
*
* - To set a list of values, provide a comma-separated list.
* For example: {@code first, second, third}.
* - To set a range of values, start the value with "range", and surrounding by square
* brackets include the minimum and maximum values, or round brackets for exclusive minimum and maximum values.
* For example: {@code range[1, 5]}, {@code range(1, 5)}, {@code range[1, 5)}.
* - To set a minimum/maximum value, use the same format for range but use "infinity"
* or "-infinity" as the second value. For example, {@code range[1, infinity]} means the
* minimum allowable value of this parameter is 1.
*
*/
String allowableValues() default "";
/**
* Allows for filtering a property from the API documentation. See io.swagger.core.filter.SwaggerSpecFilter.
*/
String access() default "";
/**
* Currently not in use.
*/
String notes() default "";
/**
* The data type of the parameter.
*
* This can be the class name or a primitive. The value will override the data type as read from the class
* property.
*/
String dataType() default "";
/**
* Specifies if the parameter is required or not.
*/
boolean required() default false;
/**
* Allows explicitly ordering the property in the model.
*/
int position() default 0;
/**
* Allows a model property to be hidden in the Swagger model definition.
*/
boolean hidden() default false;
/**
* A sample value for the property.
*/
String example() default "";
/**
* Allows a model property to be designated as read only.
*/
boolean readOnly() default false;
/**
* Specifies a reference to the corresponding type definition, overrides any other metadata specified
*/
String reference() default "";
/**
* Allows passing an empty value
*
* @since 1.5.11
*/
boolean allowEmptyValue() default false;
/**
* @return an optional array of extensions
*/
Extension[] extensions() default @Extension(properties = @ExtensionProperty(name = "", value = ""));
}