Resource

It displays the ZSPEC description provided for the <resource> in the center pane of the document.

Possible Locations

Child Elements

Custom recurrent
Authentication recurrent
Operation recurrent
Server recurrent
Tag recurrent

Attributes

Name	Type	Description
name required	String	Name of the resource as given in the ZSPEC.
title	String	The name, which has to be displayed in the help document.
sdk-languages	String (CSV, enum)	List of the programming languages for which ZEST should generate the SDK samples. The possible values are java, nodejs, php, csharp, python and ruby. By default, samples will be generated for all the ZEST supported languages.
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.

Note:

Since sdk-languages attribute can be given at multiple levels, it follows this Operation > Resource > Version > Product priority order.

Example

By default, the resource details that you provide in the ZSPEC will be picked and will be built as follows,

    
        copy
        
            
        
    
    
         
<resource name="accommodations" title="Accommodations API">
    <operation name="accommodations.GET accommodations" home-page="true" />
    <operation name="accommodations.POST accommodations" />
    <operation name="accommodations.PUT accommodations" />
    <operation name="accommodations.DELET accommodations" />
</resource>

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

Yes

Thank you for your feedback!

Send your feedback to us

Skip

Submit