Tag

It displays the ZSPEC description provided for the <tag> in the center pane of the document. In ZSPEC, all the <operation> element details for which you have specified <tag> element will be listed as sub-options of the tag name, on the menu of your help document.

Possible Locations

Child Elements

Custom recurrent
Authentication recurrent
Operation recurrent
Server recurrent
Resource recurrent

Attributes

Name	Type	Description
name required	String	Specify the name that you mentioned in the ZSPEC File.
title	String	Mention the name that has to be displayed in the help document.
home-page	Boolean	Decides whether this element has to be displayed as home page. true: It will be displayed as the home page. false (default): It will not be displayed as the home page.

Example

If you want tags, you need to add a <custom> as follows , give a suitable title and add the <operations> that should be grouped.

    
        copy
        
            
        
    
    
         
<custom title="Tags">
    <tag name="commons.composite-supported" title="Composite Allowed APIs">
        <operation name="accommodations.GET accommodations" home-page="true" />
        <operation name="accommodations.POST accommodations" />
        <operation name="accommodations.PUT accommodations" />
        <operation name="accommodations.DELET accommodations" />
    </tag>
</custom>

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

Yes

Thank you for your feedback!

Send your feedback to us

Skip

Submit