Annotation Type Tag
Swagger tag annotation.
Allows adding meta data to a single tag that is used by the Swagger Operation Object. It is not mandatory to have a Tag Object per tag used there.
Used to populate the auto-generated Swagger documentation and UI for server-side
Example:
See Also:
-
Optional Element Summary
Modifier and TypeOptional ElementDescriptionString[]
description field of the Swagger Tag Object.externalDocs field of the Swagger Tag Object.name field of the Swagger Tag Object.
-
Element Details
-
description
description field of the Swagger Tag Object.Notes:
-
The format is a Swagger object.
Multiple lines are concatenated with newlines. -
Supports SVL Variables (e.g.
"$L{my.localized.variable}" ) for the swagger generator.
- Returns:
- The annotation value.
- Default:
- {}
-
The format is a Swagger object.
-
externalDocs
externalDocs field of the Swagger Tag Object.Notes:
-
The format is a Swagger object.
Multiple lines are concatenated with newlines.
- Returns:
- The annotation value.
- Default:
- @org.apache.juneau.annotation.ExternalDocs
-
The format is a Swagger object.
-
name
- Returns:
- The annotation value.
- Default:
- ""
-