Annotation Interface OpenApi.Tag

Enclosing class:
OpenApi

@Target(TYPE) @Retention(CLASS) @Repeatable(OpenApi.Tags.class) @Documented public static @interface OpenApi.Tag
OpenAPI Tag Object metadata.

Use only on @OpenApi.Document metadata types to declare top-level tags. Use OpenApi.Operation.tags() to tag generated operations.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    Tag name.
  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Tag description.
    Tag kind.
    Parent tag name.
    Tag summary.
  • Element Details

    • value

      String value
      Tag name.
      Returns:
      name
    • description

      String description
      Tag description.
      Returns:
      description
      Default:
      ""
    • summary

      String summary
      Tag summary.

      Rendered only for OpenAPI 3.2 output.

      Returns:
      summary
      Default:
      ""
    • parent

      String parent
      Parent tag name.

      Rendered only for OpenAPI 3.2 output.

      Returns:
      parent tag name
      Default:
      ""
    • kind

      String kind
      Tag kind.

      Rendered only for OpenAPI 3.2 output.

      Returns:
      tag kind
      Default:
      ""