Tag

This element has a label which helps in grouping multiple operations under a single tag name in the API help documentation.

Possible Locations

Child Elements

Attributes

Name Type Description
name
required
String Name of the tag.
visibility String (enum) Decides who can view and use the element.
The possible values are internal, private, public. The default value is public.

Example

Assume that you want to group the GET operation of the trips and travelers resource under the name Travel Itinerary in the help document.

To achieve this, add the following tag to both operations.

    
copy
<tag name="Travel Itinerary"> <description> To group APIs together based on use case.</description> </tag>

Last Updated 2025-05-30 16:54:59 +0530 +0530