io.swagger.annotations

Annotation Type Tag

@Target(value=ANNOTATION_TYPE)
@Retention(value=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 and Description
String	name The name of this tag.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	description Optional description of the tag.
Extension[]	extensions A list of extensions associated with this tag.
ExternalDocs	externalDocs Optional reference to external documentation for this tag.

Element Detail

name

public abstract String name

The name of this tag.

Returns:

the name of this tag

description

public abstract String description

Optional description of the tag.

Returns:

an optional description of what this tag means

Default:

""

externalDocs

public abstract 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

public abstract 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=""))