io.swagger.v3.oas.annotations

Annotation Type ExternalDocumentation

@Target(value={METHOD,TYPE,ANNOTATION_TYPE})
 @Retention(value=RUNTIME)
 @Inherited
public @interface ExternalDocumentation

The annotation may be used at method level or as field of 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 Tag, Header or Schema, or as field of OpenAPIDefinition.

See Also:

External Documentation (OpenAPI specification), OpenAPIDefinition

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	description A short description of the target documentation.
Extension[]	extensions The list of optional extensions
String	url The URL for the target documentation.

Element Detail

description

public abstract String description

A short description of the target documentation.

Returns:

the documentation description

Default:

""

url

public abstract String url

The URL for the target documentation. Value must be in the format of a URL.

Returns:

the documentation URL

Default:

""

extensions

public abstract Extension[] extensions

The list of optional extensions

Returns:

an optional array of extensions

Default:

{}