io.swagger.v3.oas.annotations.ExternalDocumentation Maven / Gradle / Ivy
package io.swagger.v3.oas.annotations;
import io.swagger.v3.oas.annotations.extensions.Extension;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.ElementType.METHOD;
/**
* The annotation may be used at method level or as field of {@link Operation} to add a reference to an external
* resource for extended documentation of an Operation (OpenAPI specification).
* It may also be used to add external documentation to {@link io.swagger.v3.oas.annotations.tags.Tag},
* {@link io.swagger.v3.oas.annotations.headers.Header} or {@link io.swagger.v3.oas.annotations.media.Schema},
* or as field of {@link OpenAPIDefinition}.
*
* @see External Documentation (OpenAPI specification)
* @see OpenAPIDefinition
**/
@Target({METHOD, TYPE, ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface ExternalDocumentation {
/**
* A short description of the target documentation.
*
* @return the documentation description
**/
String description() default "";
/**
* The URL for the target documentation. Value must be in the format of a URL.
*
* @return the documentation URL
**/
String url() default "";
/**
* The list of optional extensions
*
* @return an optional array of extensions
*/
Extension[] extensions() default {};
}