Package io.swagger.annotations

Annotation Type Tag

  • @Target(ANNOTATION_TYPE)
@Retention(RUNTIME)
public @interface Tag
    A definition level Tag object see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#tag-object
    Since:
    1.5.0

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      String name
      The name of this tag.

    • Element Detail

      • name

        String name
        The name of this tag.
        Returns:
        the name of this tag

      • description

        String description
        Optional description of the tag.
        Returns:
        an optional description of what this tag means
        Default:
        ""

      • externalDocs

        ExternalDocs externalDocs
        Optional reference to external documentation for this tag.
        Returns:
        an optional reference to external documentation for this tag
        Default:
        @io.swagger.annotations.ExternalDocs(url="")

      • extensions

        Extension[] extensions
        A list of extensions associated with this tag.
        Returns:
        a list of extensions associated with this tag
        Default:
        {@io.swagger.annotations.Extension(properties={@io.swagger.annotations.ExtensionProperty(name="", value="")})}