Module org.eclipse.microprofile.openapi
Package org.eclipse.microprofile.openapi.annotations

Annotation Type ExternalDocumentation

@Target({METHOD,TYPE}) @Retention(RUNTIME) @Inherited public @interface ExternalDocumentation
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.

As of version 4.2 of the MicroProfile OpenAPI specification, use of this annotation on a type is deprecated. While implementations may continue to provide the previously-specified support for setting the documentation in the OpenAPI document root's externalDocs property from this annotation, that functionality is neither required nor recommended by the MicroProfile OpenAPI specification. Developers are instead encouraged to use the externalDocs property of the @OpenAPIDefinition directly.

See Also:

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    description
    A short description of the target documentation.
    Extension[]
    extensions
    List of extensions to be added to the ExternalDocumentation model corresponding to the containing annotation.
    String
    url
    The URL for the target documentation.

  • Element Details

    • description

      String description
      A short description of the target documentation.
      Returns:
      the documentation description
      Default:
      ""

    • url

      String url
      The URL for the target documentation. Value must be in the format of a URL.
      Returns:
      the documentation URL
      Default:
      ""

    • extensions

      Extension[] extensions
      List of extensions to be added to the ExternalDocumentation model corresponding to the containing annotation.
      Returns:
      array of extensions
      Since:
      3.1
      Default:
      {}