@Target(value={METHOD,TYPE,ANNOTATION_TYPE}) @Retention(value=RUNTIME) @Repeatable(value=Tags.class) @Inherited public @interface Tag
Operation.tags()
to define tags for the
single operation (when applied at method level) or for all operations of a class (when applied at class level).
It can also be used in OpenAPIDefinition.tags()
to define spec level tags.
When applied at method or class level, if only a name is provided, the tag will be added to operation only; if additional fields are also defined, like description or externalDocs, the Tag will also be added to openAPI.tags field
OpenAPIDefinition
Modifier and Type | Required Element and Description |
---|---|
String |
name
The name of this tag.
|
Modifier and Type | Optional Element and Description |
---|---|
String |
description
A short description for this tag.
|
Extension[] |
extensions
The list of optional extensions
|
ExternalDocumentation |
externalDocs
Additional external documentation for this tag.
|
public abstract String name
public abstract String description
public abstract ExternalDocumentation externalDocs
public abstract Extension[] extensions
Copyright © 2019. All rights reserved.