net.oneandone.neberus.annotation.ApiHeader 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.3.0

package net.oneandone.neberus.annotation;

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;

/**
 * Define a Header.

 * If defined within a {@link ApiResponse}, it will represent a response header.

 * If defined on class level, this can be used to provied descriptions of headers that are reused many times. The header name will
 * be used for reference.
 */
@Target({ ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
@Repeatable(ApiHeaders.class)
public @interface ApiHeader {

    /**
     * Name of the header. May be used on a method to reference a header defined on the class.
     *
     * @return the name
     */
    String name();

    String description() default "";

}