Annotation Interface OpenApi.ExternalDocs

Enclosing class:
OpenApi
@Target({TYPE,METHOD}) @Retention(CLASS) @Documented public static @interface OpenApi.ExternalDocs
OpenAPI External Documentation Object metadata.

Type-level usage applies only to @OpenApi.Document metadata types. Method-level usage applies to generated operations.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    value
    Documentation URL.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    description
    Documentation description.

  • Element Details

    • value

      String value
      Documentation URL.
      Returns:
      URL

    • description

      String description
      Documentation description.
      Returns:
      description
      Default:
      ""