io.swagger.oas.annotations

Annotation Type ExternalDocumentation

@Target(value=FIELD)
 @Retention(value=RUNTIME)
 @Inherited
public @interface ExternalDocumentation

Allows referencing an external resource for extended documentation.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	description A short description of the target documentation.
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:

""