@Documented @Retention(value=RUNTIME) public @interface Tag
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
Modifier and Type | Optional Element and Description |
---|---|
String[] |
description
|
ExternalDocs |
externalDocs
|
String |
name
|
String[] |
value
Free-form value for the Swagger Tag Object.
|
public abstract String[] description
public abstract ExternalDocs externalDocs
public abstract String[] value
This is a Overview > juneau-marshall > JSON Details > Simplified JSON object that makes up the swagger information for this Tag object.
The following are completely equivalent ways of defining the swagger description of the resource tags:
The reasons why you may want to use this field include:
{ }
characters are optional.
Copyright © 2018 Apache. All rights reserved.