Top Description Methods
org.eclipse.microprofile.openapi.annotations

public @Interface ExternalDocumentation

extends Annotation
Annotations
@Target:METHOD, TYPE
@Retention:RUNTIME
@Inherited
Imports
java.lang.annotation.ElementType, .Inherited, .Retention, .RetentionPolicy, .Target, org.eclipse.microprofile.openapi.annotations.extensions.Extension
This annotation allows referencing an external resource for extended documentation.

When it is applied to a method the value of the annotation is added to the corresponding OpenAPI operation definition.

When it is applied to a type and one or more of the fields are not empty strings the annotation value is added to the OpenAPI document root. If more than one non-empty annotation is applied to a type in the application or if the externalDocs field of the OpenAPIDefinition annotation is supplied the results are not defined.

See Also
OpenAPI Specification External Documentation Object

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the documentation description
description()

A short description of the target documentation.

public Extension[]

Returns:

array of extensions
extensions()

List of extensions to be added to the ExternalDocumentation model corresponding to the containing annotation.

public String

Returns:

the documentation URL
url()

The URL for the target documentation.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

descriptionback to summary
public String description()

A short description of the target documentation.

Returns:String

the documentation description

extensionsback to summary
public Extension[] extensions()

List of extensions to be added to the ExternalDocumentation model corresponding to the containing annotation.

Returns:Extension[]

array of extensions

Since
3.1
urlback to summary
public String url()

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

Returns:String

the documentation URL