org.scalatra.swagger.runtime.annotations.ApiModel 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;

/**
 * A bean class used in the REST-api.
 * Suppose you have an interface
 * @PUT @ApiOperation(...) void foo(FooBean fooBean), there is
 * no direct way to see what fields FooBean would have. This
 * annotation is meant to give a description of FooBean and
 * then have the fields of it be annotated with
 * @ApiModelProperty.
 *
 * @author Heiko W. Rupp
 */
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface ApiModel {
  /** Provide a synopsis of this class */
  String value() default "";
  /** Provide a longer description of the class */
  String description() default "";
  /** Provide a superclass for the model to allow describing inheritance */
  Class parent() default Void.class;
  /** for models with a base class, a discriminator can be provided for polymorphic use cases */
  String discriminator() default "";
}