org.scalatra.swagger.runtime.annotations.ApiModelProperty Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of scalatra-swagger-jakarta_3 Show documentation

Scalatra integration with Swagger

There is a newer version: 3.1.0

Show newest version

package org.scalatra.swagger.runtime.annotations;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/** ApiProperty can be put on a Method to allow swagger to understand the json fields datatype and more. */
@Target({ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface ApiModelProperty {
    /** Provide a human readable synopsis of this property */
    String description() default "";

    /**
    * If the values that can be set are restricted, they can be set here. In the form of a comma separated list
    * registered, active, closed.
    *
    * @return the allowable values
    */
    String allowableValues() default "";

    /**
    * specify an optional access value for filtering in a Filter
    * implementation.  This
    * allows you to hide certain parameters if a user doesn't have access to them
    */
    String access() default "";

    /** long description of the property */
    String notes() default "";

    /**
    * Whether or not the property is required, defaults to true.
    *
    * @return true if required, false otherwise
    */
    boolean required() default true;

    /**
    * allows explicitly ordering the property in the model.  Since reflection has no guarantee on
    * ordering, you should specify property order to keep models consistent across different VM implementations and versions.
    */
    int position() default Integer.MAX_VALUE;

    /**
     * Example value of the property
     */
    String example() default "";

    /**
     * Default value of the property. It can be a integer, number, bool, string or JSON string representation of
     * an array or object.
     */
    String defaultValue() default "";

    /**
     * Minimum value of the property
     */
    double minimumValue() default Double.NaN;

    /**
     * Maximum value of the property
     */
    double maximumValue() default Double.NaN;

    /**
     * Whether or not the property should be hidden from the Swagger documentation.
     * @return true if it should be hidden. Otherwise false
     */
    boolean hidden() default false;
}