net.oneandone.neberus.annotation.ApiResponseValue Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of neberus-core Show documentation

There is a newer version: 4.2.1

package net.oneandone.neberus.annotation;

import net.oneandone.neberus.parse.RestMethodData;

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

/**
 * Defines a custom parameter for a REST method. Most likely used to document fields inside the body.
 */
@Target({ ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Repeatable(ApiResponseValues.class)
public @interface ApiResponseValue {

    String name();

    String description() default "";

    /**
     * Define the type such as "path" or "query".
     *
     * @return the type
     */
    RestMethodData.ParameterType type() default RestMethodData.ParameterType.UNSET;

    /**
     * Defines which values can be returned.
     *
     * @return the allowed values
     */
    String[] allowedValues() default {};

    /**
     * If set, the responseValue will be grouped under the corresponding response entity description. Defining a class that is
     * not used for any response entity will cause this responseValue to disappear.
     *
     * @return the container class
     */
    Class containerClass() default Void.class;

}