├── .gitignore
├── README.md
└── spec-studio
    └── 1_0_0
        ├── travelbureau
            └── v1
            │   └── specifications
            │       ├── accommodations.xml
            │       ├── destinations.xml
            │       ├── trips.xml
            │       ├── travelers.xml
            │       └── commons.xml
        └── xsd
            ├── spec.xsd
            └── components.xsd


/.gitignore:
--------------------------------------------------------------------------------
1 | .DS_Store


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # zest-samples
2 | 
3 | You can explore a wide range of ZEST samples in our GitHub repository. These samples are curated to help you understand and implement ZEST effectively for your API development needs. Use these examples as a starting point to streamline your API design process with ZEST.
4 | 
5 | You can access the latest version of ZEST specification samples [here](/spec-studio/1_0_0).


--------------------------------------------------------------------------------
/spec-studio/1_0_0/travelbureau/v1/specifications/accommodations.xml:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="UTF-8"?>
  2 | <resource name="accommodations" product="travelbureau" pre-loaded="false" specification="1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../xsd/spec.xsd">
  3 |     <components>
  4 |         <structure ref-name="Accommodation">
  5 |             <property name="id" type="long_string" include-for="Request[update], Response[read]" required-for="all">
  6 |                 <description>The unique record ID of the accommodation.</description>
  7 |             </property>
  8 |             <property name="name" type="string" required-for="all" unique-for="all">
  9 |                 <description>Name of the accommodation place.</description>
 10 |             </property>
 11 |             <property name="check_in_date" type="datetime" required-for="response">
 12 |                 <description>Your arrival date at the place.</description>
 13 |             </property>
 14 |             <property name="check_out_date" type="datetime" required-for="response">
 15 |                 <description>The departure date indicating the end of your stay.</description>
 16 |             </property>
 17 |         </structure>
 18 | 
 19 |         <request-body name="AccommodationBody">
 20 |             <content>
 21 |                 <encode type="application/json" />
 22 |                 <structure-ref name="Accommodation" />
 23 |             </content>
 24 |         </request-body>
 25 | 
 26 |         <argument name="ids" location="param" length="200" delimiter="," style="delimiter">
 27 |             <description>Specify the ids for which the operation has to take place.</description>
 28 |             <content>
 29 |                 <encode type="text/plain"/>
 30 |                 <structure>
 31 |                     <property path="accommodations:$.id" type="long"/>
 32 |                 </structure>
 33 |             </content>
 34 |         </argument>
 35 |     </components>
 36 | 
 37 |     <info title="Accommodations" version="1">
 38 |         <description>The accommodations hold the basic details for staying in a hotel, hostel, resort, vacation and rental. This API supports all the four CRUD operations to efficiently manage records in the resource.</description>
 39 | 
 40 |         <terms-of-service-ref name="commons.Terms and Conditions"/>
 41 |         <contact-details-ref name="commons.Travel Bureau Support"/>
 42 |         <license-details-ref name="commons.Apache License 2"/>
 43 |     </info>
 44 | 
 45 |     <resource-config primary-structure="Accommodation">
 46 |         <path-config data-extraction-path="$">
 47 |             <primary path="$.id"/>
 48 |         </path-config>
 49 |     </resource-config>
 50 | 
 51 |     <server-ref name="commons.TravelBureauAPIServer"/>
 52 | 
 53 |     <url path="/api/v1/accommodations">
 54 |         <operation category="read" method="get" name="Get Accommodations">
 55 |             <description>This operation fetches the accommodation details available in the Travel Bureau. You can also provide the IDs of the records to get the details of particular records.</description>
 56 | 
 57 |             <argument-ref name="ids"/>
 58 | 
 59 |             <response status="200">
 60 |                 <content>
 61 |                     <encode type="application/json" />
 62 |                     <path-config data-extraction-path="$.accommodations" />
 63 |                     <structure name="AccommodationsWrapper">
 64 |                         <property name="accommodations" type="collections" required-for="response">
 65 |                             <structure-ref name="Accommodation" />
 66 |                         </property>
 67 |                     </structure>
 68 |                 </content>
 69 |             </response>
 70 |             <response-ref name="commons.InvalidParamResponse" />
 71 | 
 72 |             <authentication location="header" name="Authorization" schema="commons.OAuth2Schema" scopes="TravelBureau.accommodations.READ" type="oauth2"/>
 73 |         </operation>
 74 | 
 75 |         <operation category="create" method="post" name="Create Accommodation">
 76 |             <description>It helps you to add new accommodation to the Travel Bureau.</description>
 77 | 
 78 |             <request-body-ref name="AccommodationBody"/>
 79 | 
 80 |             <response-ref name="commons.CreateSuccess"/>
 81 |             <response-ref name="commons.BadRequest"/>
 82 |             
 83 |             <authentication location="header" name="Authorization" schema="commons.OAuth2Schema" scopes="TravelBureau.accommodations.CREATE" type="oauth2"/>
 84 |         </operation>
 85 | 
 86 |         <operation category="update" method="put" name="Update Accommodation">
 87 |             <description>It aids you in updating the details of the existing accommodation in the Travel Bureau.</description>
 88 | 
 89 |             <request-body-ref name="AccommodationBody"/>
 90 | 
 91 |             <response-ref name="commons.UpdateSuccess"/>
 92 |             <response-ref name="commons.BadRequest"/>
 93 | 
 94 |             <authentication location="header" name="Authorization" schema="commons.OAuth2Schema" scopes="TravelBureau.accommodations.UPDATE" type="oauth2"/>
 95 |         </operation>
 96 | 
 97 |         <operation category="delete" method="delete" name="Delete Accommodations">
 98 |             <description>This helps you to delete the existing accommodation records in the Travel Bureau.</description>
 99 | 
100 |             <argument-ref name="ids"/>
101 | 
102 |             <response status="200">
103 |                 <content>
104 |                     <encode type="application/json" />
105 |                     <path-config data-extraction-path="$.accommodations" />
106 |                     <structure name="AccommodationsWrapper">
107 |                         <property name="accommodations" type="collections" required-for="response">
108 |                             <structure-ref name="commons.DeleteActionResponse" />
109 |                         </property>
110 |                     </structure>
111 |                 </content>
112 |             </response>
113 |             <response-ref name="commons.InvalidParamResponse" />
114 | 
115 |             <authentication location="header" name="Authorization" schema="commons.OAuth2Schema" scopes="TravelBureau.accommodations.DELETE" type="oauth2"/>
116 |         </operation>
117 |     </url>
118 | 
119 |     <authentication location="header" name="Authorization" schema="commons.OAuth2Schema" scopes="TravelBureau.accommodations.ALL" type="oauth2"/>
120 | </resource>
121 | 


--------------------------------------------------------------------------------
/spec-studio/1_0_0/travelbureau/v1/specifications/destinations.xml:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="UTF-8"?>
  2 | <resource name="destinations" product="travelbureau" pre-loaded="false" specification="1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../xsd/spec.xsd">
  3 |     <components>
  4 |         <structure name="Destination" ref-name="Destination">
  5 |             <property name="id" type="long_string" include-for="Request[update], Response[read]" required-for="all">
  6 |                 <description>The unique record ID of the destination.</description>
  7 |             </property>
  8 |             <property name="name" type="string" required-for="all" unique-for="all">
  9 |                 <description>Name of the destination.</description>
 10 |             </property>
 11 |             <property name="travelogue" type="string" content-types="text/html">
 12 |                 <description>Provides the comprehensive details about the destination and places nearby to explore. The value for this key should be given in the HTML format.</description>
 13 |             </property>
 14 |             <property name="rating" type="integer" range="1,10">
 15 |                 <description>Denotes the rating of a particular destination based on the general public reviews.</description>
 16 |             </property>
 17 |         </structure>
 18 | 
 19 |         <request-body name="DestinationBody">
 20 |             <content>
 21 |                 <encode type="application/json" />
 22 |                 <structure-ref name="Destination" />
 23 |             </content>
 24 |         </request-body>
 25 | 
 26 |         <argument name="ids" location="param" length="200" delimiter="," style="delimiter">
 27 |             <description>Specify the ids for which the operation has to take place.</description>
 28 |             <content>
 29 |                 <encode type="text/plain"/>
 30 |                 <structure>
 31 |                     <property path="destinations:$.id" type="collections"/>
 32 |                 </structure>
 33 |             </content>
 34 |         </argument>
 35 |     </components>
 36 | 
 37 |     <info title="Destinations" version="1">
 38 |         <description>This resource serves as a gateway to the world's most enchanting and diverse locales. It provides details such as famous nearby places to visit, accompanied by pictures and a comprehensive travelogue for each destination. The API facilitates efficient retrieval, management, and utilization of destination data.</description>
 39 | 
 40 |         <terms-of-service-ref name="commons.Terms and Conditions"/>
 41 |         <contact-details-ref name="commons.Travel Bureau Support"/>
 42 |         <license-details-ref name="commons.Apache License 2"/>
 43 |     </info>
 44 | 
 45 |     <resource-config primary-structure="Destination">
 46 |         <path-config data-extraction-path="$">
 47 |             <primary path="$.id"/>
 48 |         </path-config>
 49 |     </resource-config>
 50 | 
 51 |     <server-ref name="commons.TravelBureauAPIServer"/>
 52 | 
 53 |     <url path="/api/v1/destinations">
 54 |         <operation category="read" method="get" name="Get Destinations">
 55 |             <description>This operation fetches the destination details available in the Travel Bureau. You can also provide the IDs of the records to get the details of particular records.</description>
 56 | 
 57 |             <argument-ref name="ids"/>
 58 | 
 59 |             <response status="200">
 60 |                 <content>
 61 |                     <encode type="application/json" />
 62 |                     <path-config data-extraction-path="$.destinations" />
 63 |                     <structure name="DestinationsWrapper">
 64 |                         <property name="destinations" type="collections" required-for="response">
 65 |                             <structure-ref name="Destination" />
 66 |                         </property>
 67 |                     </structure>
 68 |                 </content>
 69 |             </response>
 70 |             <response-ref name="commons.InvalidParamResponse" />
 71 | 
 72 |             <authentication location="header" name="Authorization" schema="commons.OAuth2Schema" scopes="TravelBureau.destinations.READ" type="oauth2"/>
 73 |         </operation>
 74 | 
 75 |         <operation category="create" method="post" name="Create Destination">
 76 |             <description>It helps you to add new destination to the Travel Bureau.</description>
 77 | 
 78 |             <request-body-ref name="DestinationBody"/>
 79 | 
 80 |             <response-ref name="commons.CreateSuccess"/>
 81 |             <response-ref name="commons.BadRequest"/>
 82 | 
 83 |             <authentication location="header" name="Authorization" schema="commons.OAuth2Schema" scopes="TravelBureau.destinations.CREATE" type="oauth2"/>
 84 |         </operation>
 85 | 
 86 |         <operation category="update" method="put" name="Update Destinations">
 87 |             <description>It aids you in updating the details of the existing destination in the Travel Bureau.</description>
 88 | 
 89 |             <request-body-ref name="DestinationBody"/>
 90 | 
 91 |             <response-ref name="commons.UpdateSuccess"/>
 92 |             <response-ref name="commons.BadRequest"/>
 93 | 
 94 |             <authentication location="header" name="Authorization" schema="commons.OAuth2Schema" scopes="TravelBureau.destinations.UPDATE" type="oauth2"/>
 95 |         </operation>
 96 | 
 97 |         <operation category="delete" method="delete" name="Delete Destinations">
 98 |             <description>This helps you to delete the existing destination records in the Travel Bureau.</description>
 99 | 
100 |             <argument-ref name="ids"/>
101 | 
102 |             <response status="200">
103 |                 <content>
104 |                     <encode type="application/json" />
105 |                     <path-config data-extraction-path="$.destinations" />
106 |                     <structure name="DestinationsWrapper">
107 |                         <property name="destinations" type="collections" required-for="response">
108 |                             <structure-ref name="commons.DeleteActionResponse" />
109 |                         </property>
110 |                     </structure>
111 |                 </content>
112 |             </response>
113 |             <response-ref name="commons.InvalidParamResponse" />
114 | 
115 |             <authentication location="header" name="Authorization" schema="commons.OAuth2Schema" scopes="TravelBureau.destinations.DELETE" type="oauth2"/>
116 |         </operation>
117 |     </url>
118 | 
119 |     <authentication location="header" name="Authorization" schema="commons.OAuth2Schema" scopes="TravelBureau.destinations.ALL" type="oauth2"/>
120 | </resource>
121 | 


--------------------------------------------------------------------------------
/spec-studio/1_0_0/travelbureau/v1/specifications/trips.xml:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="UTF-8"?>
  2 | <resource name="trips" product="travelbureau" pre-loaded="false" specification="1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../xsd/spec.xsd">
  3 |     <components>
  4 |         <structure ref-name="Trip">
  5 |             <property name="name" type="string" required-for="all" unique-for="all">
  6 |                 <description>Name of the trip.</description>
  7 |             </property>
  8 |             <property name="id" type="long_string" include-for="Request[update], Response[read]" required-for="all">
  9 |                 <description>The unique record ID of the trip.</description>
 10 |             </property>
 11 |             <property name="destination" type="string" path="destinations:$.name" required-for="all">
 12 |                 <description>Destination of the trip.</description>
 13 |             </property>
 14 |             <property name="start_time" type="datetime" required-for="all">
 15 |                 <description>The starting time of the trip.</description>
 16 |             </property>
 17 |             <property name="end_time" type="datetime" required-for="all" format="yyyy-MM-dd'T'HH:mm:ss+/-hh:mm" value-condition="> REQUEST:body.start_time">
 18 |                 <description>The ending time of the trip.</description>
 19 |             </property>
 20 |             <property name="no_of_days" type="integer" required-for="all">
 21 |                 <description>The total number of trip days.</description>
 22 |             </property>
 23 |             <property name="transport_medium" type="string" required-for="all" values="Roadways,Airways,Waterways,Hybrid" default-value="Roadways" extra-value="map-default">
 24 |                 <description>Your preferred medium of transport.</description>
 25 |             </property>
 26 |             <property name="hybrid_details" type="string" condition-for-all="$.body.transport_medium == 'Hybrid'" required-for="all">
 27 |                 <description>Elaborate your hybrid details and the list of your preferred medium of transport.</description>
 28 |             </property>
 29 |             <property name="accommodation_type" type="string" required-for="all" values="Hotel,Resort,Vacation Rental,Hostel" default-value="Hotel" invalid-value="map-default">
 30 |                 <description>Type of your accommodation.</description>
 31 |             </property>
 32 |             <property name="trip_budget" type="integer" required-for="all">
 33 |                 <description>Budget of your trip.</description>
 34 |             </property>
 35 |             <property name="adventure_activities" type="object">
 36 |                 <extend-property condition-for-all="'Automation' :: REQUEST:$.header.service" length="3,-1" type="collections">
 37 |                     <description>List of adventure activities according to the suggestions of traveler(s).</description>
 38 |                     <structure>
 39 |                         <property type="string"/>
 40 |                     </structure>
 41 |                 </extend-property>
 42 |                 <extend-property condition-for-all="REQUEST:$.header.service == null || REQUEST:$.header.service != Automation" type="boolean">
 43 |                     <description>
 44 | Denotes whether adventure activities can be included in the trip. 
 45 |     - **true**: Adventure activities will be included in the trip. 
 46 |     - **false**: Adventure activities are not included in the trip.
 47 |                     </description>
 48 |                 </extend-property>
 49 |             </property>
 50 |         </structure>
 51 | 
 52 |         <request-body name="TripBody">
 53 |             <content>
 54 |                 <encode type="application/json" />
 55 |                 <structure-ref name="Trip" />
 56 |             </content>
 57 |         </request-body>
 58 | 
 59 |         <argument name="ids" location="param" length="200" delimiter="," style="delimiter">
 60 |             <description>Specify the id(s) for which the operation has to take place.</description>
 61 |             <content>
 62 |                 <encode type="text/plain"/>
 63 |                 <structure>
 64 |                     <property path="trips:$.id" type="long"/>
 65 |                 </structure>
 66 |             </content>
 67 |         </argument>
 68 | 
 69 |         <argument location="header" name="service" visibility="internal">
 70 |             <description>Specify the service from which the resource is consumed.</description>
 71 |             <content>
 72 |                 <encode type="text/plain"/>
 73 |                 <structure>
 74 |                     <property type="string" values="Automation,Audit,QA"/>
 75 |                 </structure>
 76 |             </content>
 77 |         </argument>
 78 |     </components>
 79 | 
 80 |     <info title="Trips" version="1">
 81 |         <description>Trips holds details such as trip itineraries, departure and arrival information, and other relevant data regarding a trip in the Travel Bureau. It offers all four CRUD operations for the effective management of records in the resource.</description>
 82 | 
 83 |         <terms-of-service-ref name="commons.Terms and Conditions"/>
 84 |         <contact-details-ref name="commons.Travel Bureau Support"/>
 85 |         <license-details-ref name="commons.Apache License 2"/>
 86 |     </info>
 87 |     
 88 |     <resource-config primary-structure="Trip">
 89 |         <path-config data-extraction-path="$">
 90 |             <primary path="$.id"/>
 91 |         </path-config>
 92 |     </resource-config>
 93 | 
 94 |     <server-ref name="commons.TravelBureauAPIServer"/>
 95 | 
 96 |     <url path="/api/v1/trips">
 97 |         <operation category="read" method="get" name="Get trips">
 98 |             <description>This operation fetches the trips details available in the Travel Bureau. You can also provide the IDs of the records to get only the details of particular records.</description>
 99 | 
100 |             <argument-ref name="ids"/>
101 |             <argument-ref name="service"/>
102 | 
103 |             <response status="200">
104 |                 <content>
105 |                     <encode type="application/json" />
106 |                     <path-config data-extraction-path="$.trips" />
107 |                     <structure name="TripsWrapper">
108 |                         <property name="trips" type="collections" required-for="response">
109 |                             <structure-ref name="Trip" />
110 |                         </property>
111 |                     </structure>
112 |                 </content>
113 |             </response>
114 |             <response-ref name="commons.InvalidParamResponse" />
115 | 
116 |             <authentication location="header" name="Authorization" schema="commons.OAuth2Schema" scopes="TravelBureau.trips.READ" type="oauth2"/>
117 |         </operation>
118 | 
119 |         <operation category="create" method="post" name="Add Trip">
120 |             <description>It helps you to add new trips to the Travel Bureau.</description>
121 | 
122 |             <argument-ref name="service"/>
123 | 
124 |             <request-body-ref name="TripBody"/>
125 | 
126 |             <response-ref name="commons.CreateSuccess"/>
127 |             <response-ref name="commons.BadRequest"/>
128 | 
129 |             <authentication location="header" name="Authorization" schema="commons.OAuth2Schema" scopes="TravelBureau.trips.CREATE" type="oauth2"/>
130 |         </operation>
131 | 
132 |         <operation category="update" method="put" name="Update Trip">
133 |             <description>It aids you in updating the details of the existing trips data in the Travel Bureau.</description>
134 | 
135 |             <argument-ref name="service"/>
136 | 
137 |             <request-body-ref name="TripBody"/>
138 | 
139 |             <response-ref name="commons.UpdateSuccess"/>
140 |             <response-ref name="commons.BadRequest"/>
141 | 
142 |             <authentication location="header" name="Authorization" schema="commons.OAuth2Schema" scopes="TravelBureau.trips.UPDATE" type="oauth2"/>
143 |         </operation>
144 | 
145 |         <operation category="delete" method="delete" name="Delete Trip">
146 |             <description>This helps you to delete the existing trips records in the Travel Bureau.</description>
147 | 
148 |             <argument-ref name="ids"/>
149 | 
150 |             <response status="200">
151 |                 <content>
152 |                     <encode type="application/json" />
153 |                     <path-config data-extraction-path="$.trips" />
154 |                     <structure name="TripsWrapper">
155 |                         <property name="trips" type="collections" required-for="response">
156 |                             <structure-ref name="commons.DeleteActionResponse" />
157 |                         </property>
158 |                     </structure>
159 |                 </content>
160 |             </response>
161 |             <response-ref name="commons.InvalidParamResponse" />
162 | 
163 |             <authentication location="header" name="Authorization" schema="commons.OAuth2Schema" scopes="TravelBureau.trips.DELETE" type="oauth2"/>
164 |         </operation>
165 |     </url>
166 | 
167 |     <authentication location="header" name="Authorization" schema="commons.OAuth2Schema" scopes="TravelBureau.trips.ALL" type="oauth2"/>
168 | </resource>
169 | 


--------------------------------------------------------------------------------
/spec-studio/1_0_0/travelbureau/v1/specifications/travelers.xml:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="UTF-8"?>
  2 | <resource name="travelers" product="travelbureau" pre-loaded="false" specification="1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../xsd/spec.xsd">
  3 |     <components>
  4 |         <structure ref-name="Traveler">
  5 |             <property name="id" include-for="Request[update], Response[read]" required-for="all" type="long_string">
  6 |                 <description>The unique record ID of the traveler.</description>
  7 |             </property>
  8 |             <property name="name" type="collections" required-for="all">
  9 |                 <description>Name of the traveler.</description>
 10 |                 <ordered-structures>
 11 |                     <structure>
 12 |                         <property type="string" values="Mr,Miss,Mrs">
 13 |                             <description>Provide any one of the titles from the possible values.</description>
 14 |                         </property>
 15 |                     </structure>
 16 |                     <structure>
 17 |                         <property regex="^[^\s]+$" type="string">
 18 |                             <description>Provide your first name without any space.</description>
 19 |                         </property>
 20 |                     </structure>
 21 |                     <structure>
 22 |                         <property type="string">
 23 |                             <description>Provide your family name.</description>
 24 |                         </property>
 25 |                     </structure>
 26 |                     <structure>
 27 |                         <property regex="^alias ([a-zA-Z\s]+)$" type="string">
 28 |                             <description>Provide your nick name, if you have any.</description>
 29 |                         </property>
 30 |                     </structure>
 31 |                 </ordered-structures>
 32 |             </property>
 33 |             <property name="email" type="string" required-for="all" unique-for="all">
 34 |                 <description>Email ID of the traveler.</description>
 35 |             </property>
 36 |             <property name="services" type="collections" required-for="response">
 37 |                 <description>The services chosen by the traveler from the Travel Bureau. The possible values are **flight** and **train**.</description>
 38 |                 <structure-group name="services" type="one-of">
 39 |                     <structure name="Flight" discriminator-value="flight">
 40 |                         <property name="flight_no" type="string" required-for="response">
 41 |                             <description>Number of the flight for the traveler's journey.</description>
 42 |                         </property>
 43 |                         <property name="departure_airport" type="string" required-for="response">
 44 |                             <description>The airport name, where the journey begins.</description>
 45 |                         </property>
 46 |                         <property name="arrival_airport" type="string" required-for="response">
 47 |                             <description>Name of the destination airport, where the journey concludes.</description>
 48 |                         </property>
 49 |                     </structure>
 50 |                     <structure name="Train" discriminator-value="train">
 51 |                         <property name="train_no" type="string" required-for="response">
 52 |                             <description>Number of the train for the traveler's journey.</description>
 53 |                         </property>
 54 |                         <property name="departure_station" type="string" required-for="response">
 55 |                             <description>The station name, where the journey begins.</description>
 56 |                         </property>
 57 |                         <property name="arrival_station" type="string" required-for="response">
 58 |                             <description>Name of the destination station, where the journey concludes.</description>
 59 |                         </property>
 60 |                     </structure>
 61 |                     <discriminator property-name="type" />
 62 |                 </structure-group>
 63 |             </property>           
 64 |         </structure>
 65 | 
 66 |         <request-body name="TravelerRequestBody">
 67 |             <content>
 68 |                 <encode type="application/json" />
 69 |                 <structure-ref name="Traveler" />
 70 |             </content>
 71 |         </request-body>
 72 | 
 73 |         <argument name="ids" location="param" length="200" delimiter="," style="delimiter">
 74 |             <description>Specify the id(s) for which the operation has to take place.</description>
 75 |             <content>
 76 |                 <encode type="text/plain"/>
 77 |                 <structure>
 78 |                     <property path="travelers:$.id" type="long"/>
 79 |                 </structure>
 80 |             </content>
 81 |         </argument>
 82 |     </components>
 83 | 
 84 |     <info title="Travelers" version="1">
 85 |         <description>The details of the travelers are stored in this resource, where you can read, create, update and delete the records.</description>
 86 | 
 87 |         <terms-of-service-ref name="commons.Terms and Conditions"/>
 88 |         <contact-details-ref name="commons.Travel Bureau Support"/>
 89 |         <license-details-ref name="commons.Apache License 2"/>
 90 |     </info>
 91 | 
 92 |     <resource-config primary-structure="Traveler">
 93 |         <path-config data-extraction-path="$">
 94 |             <primary path="$.id"/>
 95 |         </path-config>
 96 |     </resource-config>
 97 | 
 98 |     <server-ref name="commons.TravelBureauAPIServer"/>
 99 | 
100 |     <url path="/api/v1/travelers">
101 |         <operation category="read" method="get" name="Get Travelers">
102 |             <description>This operation fetches the travelers details available in the Travel Bureau. You can also provide the IDs of the records to get the details of particular records.</description>
103 | 
104 |             <argument-ref name="ids"/>
105 | 
106 |             <response status="200">
107 |                 <content>
108 |                     <encode type="application/json" />
109 |                     <path-config data-extraction-path="$.travelers" />
110 |                     <structure name="TravelersWrapper">
111 |                         <property name="travelers" type="collections" required-for="response">
112 |                             <structure-ref name="Traveler" />
113 |                         </property>
114 |                     </structure>
115 |                 </content>
116 |             </response>
117 |             <response-ref name="commons.InvalidParamResponse" />
118 | 
119 |             <authentication location="header" name="Authorization" schema="commons.OAuth2Schema" scopes="TravelBureau.travelers.READ" type="oauth2"/>
120 |         </operation>
121 | 
122 |         <operation category="create" method="post" name="Add Traveler">
123 |             <description>It helps you to add new travelers data to the Travel Bureau.</description>
124 | 
125 |             <request-body-ref name="TravelerRequestBody"/>
126 | 
127 |             <response-ref name="commons.CreateSuccess"/>
128 |             <response-ref name="commons.BadRequest"/>
129 | 
130 |             <authentication location="header" name="Authorization" schema="commons.OAuth2Schema" scopes="TravelBureau.travelers.CREATE" type="oauth2"/>
131 |         </operation>
132 | 
133 |         <operation category="update" method="put" name="Update Traveler">
134 |             <description>It aids you in updating the details of the existing travelers data in the Travel Bureau.</description>
135 | 
136 |             <request-body-ref name="TravelerRequestBody"/>
137 | 
138 |             <response-ref name="commons.UpdateSuccess"/>
139 |             <response-ref name="commons.BadRequest"/>
140 | 
141 |             <authentication location="header" name="Authorization" schema="commons.OAuth2Schema" scopes="TravelBureau.travelers.UPDATE" type="oauth2"/>
142 |         </operation>
143 | 
144 |         <operation category="delete" method="delete" name="Delete Traveler">
145 |             <description>This helps you to delete the existing travelers records in the Travel Bureau.</description>
146 | 
147 |             <argument-ref name="ids"/>
148 | 
149 |             <response status="200">
150 |                 <content>
151 |                     <encode type="application/json" />
152 |                     <path-config data-extraction-path="$.travelers" />
153 |                     <structure name="TravelersWrapper">
154 |                         <property name="travelers" type="collections" required-for="response">
155 |                             <structure-ref name="commons.DeleteActionResponse" />
156 |                         </property>
157 |                     </structure>
158 |                 </content>
159 |             </response>
160 |             <response-ref name="commons.InvalidParamResponse" />
161 | 
162 |             <authentication location="header" name="Authorization" schema="commons.OAuth2Schema" scopes="TravelBureau.travelers.DELETE" type="oauth2"/>
163 |         </operation>
164 |     </url>
165 | 
166 |     <authentication location="header" name="Authorization" schema="commons.OAuth2Schema" scopes="TravelBureau.travelers.ALL" type="oauth2"/>
167 | </resource>
168 | 


--------------------------------------------------------------------------------
/spec-studio/1_0_0/xsd/spec.xsd:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="UTF-8"?>
  2 | <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
  3 | 	<xs:include schemaLocation="components.xsd" />
  4 | 	<xs:element name="resource">
  5 | 		<xs:annotation>
  6 | 			<xs:documentation>This acts as the root element of the ZSPEC XML file.</xs:documentation>
  7 | 		</xs:annotation>
  8 | 		<xs:complexType>
  9 | 			<xs:sequence>
 10 | 				<xs:element name="components" minOccurs="0" type="components">
 11 | 					<xs:annotation>
 12 | 						<xs:documentation>This element acts as a <b>storage container for other elements that can be reused</b> within a resource and <b>across multiple resources</b>. It reduces the recurrence of similar tags, optimising the long-winded files with conciser codes. All the child elements of components should have the <b>ref-name</b> attribute with <b>unique value</b>. Whenever you want to reuse that child element, enter the value of <b>ref-name</b> in the <b>name</b> attribute of corresponding ref element.</xs:documentation>
 13 | 					</xs:annotation>
 14 | 					<xs:unique name="unique-example-name">
 15 | 						<xs:selector xpath="example"></xs:selector>
 16 | 						<xs:field xpath="@name"></xs:field>
 17 | 					</xs:unique>
 18 | 					<xs:unique name="unique-structure-name">
 19 | 						<xs:selector xpath="structure"></xs:selector>
 20 | 						<xs:field xpath="@ref-name"></xs:field>
 21 | 					</xs:unique>
 22 | 					<xs:unique name="unique-content-name">
 23 | 						<xs:selector xpath="content"></xs:selector>
 24 | 						<xs:field xpath="@name"></xs:field>
 25 | 					</xs:unique>
 26 | 					<xs:unique name="unique-argument-name">
 27 | 						<xs:selector xpath="argument"></xs:selector>
 28 | 						<xs:field xpath="@name"></xs:field>
 29 | 					</xs:unique>
 30 | 					<xs:unique name="unique-request-body-name">
 31 | 						<xs:selector xpath="request-body"></xs:selector>
 32 | 						<xs:field xpath="@name"></xs:field>
 33 | 					</xs:unique>
 34 | 					<xs:unique name="unique-response-name">
 35 | 						<xs:selector xpath="response"></xs:selector>
 36 | 						<xs:field xpath="@name"></xs:field>
 37 | 					</xs:unique>
 38 | 					<xs:unique name="unique-server-name">
 39 | 						<xs:selector xpath="server"></xs:selector>
 40 | 						<xs:field xpath="@name"></xs:field>
 41 | 					</xs:unique>
 42 | 					<xs:unique name="unique-contact-details-name">
 43 | 						<xs:selector xpath="contact-details"></xs:selector>
 44 | 						<xs:field xpath="@name"></xs:field>
 45 | 					</xs:unique>
 46 | 					<xs:unique name="unique-license-details-name">
 47 | 						<xs:selector xpath="license-details"></xs:selector>
 48 | 						<xs:field xpath="@name"></xs:field>
 49 | 					</xs:unique>
 50 | 					<xs:unique name="unique-terms-of-service-name">
 51 | 						<xs:selector xpath="terms-of-service"></xs:selector>
 52 | 						<xs:field xpath="@name"></xs:field>
 53 | 					</xs:unique>
 54 | 					<xs:unique name="unique-tag-name">
 55 | 						<xs:selector xpath="tag"></xs:selector>
 56 | 						<xs:field xpath="@name"></xs:field>
 57 | 					</xs:unique>
 58 | 					<xs:unique name="unique-token-name">
 59 | 						<xs:selector xpath="token"></xs:selector>
 60 | 						<xs:field xpath="@name"></xs:field>
 61 | 					</xs:unique>
 62 | 					<xs:unique name="unique-oauth2-name">
 63 | 						<xs:selector xpath="oauth2"></xs:selector>
 64 | 						<xs:field xpath="@name"></xs:field>
 65 | 					</xs:unique>
 66 | 					<xs:unique name="unique-throttling-name">
 67 | 						<xs:selector xpath="throttling"></xs:selector>
 68 | 						<xs:field xpath="@name"></xs:field>
 69 | 					</xs:unique>
 70 | 				</xs:element>
 71 | 				<xs:element name="info">
 72 | 					<xs:annotation>
 73 | 						<xs:documentation>Provide details about the API, including its version, terms of service, and license information. All these details will be added to the <b>help document</b>. Addedly, the version and limit details will be used for automation and SDK generation.</xs:documentation>
 74 | 					</xs:annotation>
 75 | 					<xs:complexType>
 76 | 						<xs:sequence>
 77 | 							<xs:element ref="description" />
 78 | 							<xs:choice minOccurs="0">
 79 | 								<xs:element name="terms-of-service" type="xs:string">
 80 | 									<xs:annotation>
 81 | 										<xs:documentation>Give the details of terms of service of the API as an <b>MD String</b>.</xs:documentation>
 82 | 									</xs:annotation>
 83 | 								</xs:element>
 84 | 								<xs:element ref="terms-of-service-ref" />
 85 | 							</xs:choice>
 86 | 							<xs:choice minOccurs="0" maxOccurs="unbounded">
 87 | 								<xs:element name="contact-details" type="contact-details">
 88 | 									<xs:annotation>
 89 | 										<xs:documentation>Provide the contact information for <b>users to get in touch</b> or reach out for assistance. This content will be added to the help documentation.</xs:documentation>
 90 | 									</xs:annotation>
 91 | 								</xs:element>
 92 | 								<xs:element ref="contact-details-ref" />
 93 | 							</xs:choice>
 94 | 							<xs:choice minOccurs="0">
 95 | 								<xs:element ref="license-details" />
 96 | 								<xs:element ref="license-details-ref" />
 97 | 							</xs:choice>
 98 | 						</xs:sequence>
 99 | 						<xs:attribute name="title" type="any-string" use="required">
100 | 							<xs:annotation>
101 | 								<xs:documentation>Give a title for the API help document.</xs:documentation>
102 | 							</xs:annotation>
103 | 						</xs:attribute>
104 | 						<xs:attribute name="version" type="version-string" use="required">
105 | 							<xs:annotation>
106 | 								<xs:documentation>Mention the API version. This attribute follows the semantic versioning format - major.minor.patch (e.g., 1.0.0, 2.1, or 3), where the major version is required, and each part is a non-negative integer.</xs:documentation>
107 | 							</xs:annotation>
108 | 						</xs:attribute>
109 | 						<xs:attribute name="limit" type="xs:positiveInteger">
110 | 							<xs:annotation>
111 | 								<xs:documentation>Mention the limitations that you want to be added to the help documentation for the resource if any. Also when automation cases are generated, the limit will be taken into consideration. For example, when you mention limit="100" for Module resource, the maximum possible number of modules in CRM is 100. This will be published in help documents. This limit will also be covered as an automation case.</xs:documentation>
112 | 							</xs:annotation>
113 | 						</xs:attribute>
114 | 					</xs:complexType>
115 | 					<xs:unique name="unique-contact-details">
116 | 						<xs:selector xpath="contact-details|contact-details-ref"></xs:selector>
117 | 						<xs:field xpath="@name"></xs:field>
118 | 					</xs:unique>
119 | 				</xs:element>
120 | 				<xs:element name="resource-config">
121 | 					<xs:annotation>
122 | 						<xs:documentation>Give additional <b>details about the resource</b>.</xs:documentation>
123 | 					</xs:annotation>
124 | 					<xs:complexType>
125 | 						<xs:sequence>
126 | 							<xs:element ref="path-config" />
127 | 						</xs:sequence>
128 | 						<xs:attribute name="primary-type" default="simple">
129 | 							<xs:annotation>
130 | 								<xs:documentation>It decides the behaviour of the primary keys.</xs:documentation>
131 | 							</xs:annotation>
132 | 							<xs:simpleType>
133 | 								<xs:restriction base="xs:string">
134 | 									<xs:enumeration value="simple">
135 | 										<xs:annotation>
136 | 											<xs:documentation>Each and every primary property will function as an individual primary key.</xs:documentation>
137 | 										</xs:annotation>
138 | 									</xs:enumeration>
139 | 									<xs:enumeration value="composite">
140 | 										<xs:annotation>
141 | 											<xs:documentation>All the primary properties will function together as a single primary key.</xs:documentation>
142 | 										</xs:annotation>
143 | 									</xs:enumeration>
144 | 								</xs:restriction>
145 | 							</xs:simpleType>
146 | 						</xs:attribute>
147 | 						<xs:attribute name="primary-structure" type="name-string">
148 | 							<xs:annotation>
149 | 								<xs:documentation>Give the <b>name</b> of the core structure of the resource.</xs:documentation>
150 | 							</xs:annotation>
151 | 						</xs:attribute>
152 | 						<xs:anyAttribute processContents="lax" />
153 | 					</xs:complexType>
154 | 				</xs:element>
155 | 				<xs:choice maxOccurs="unbounded">
156 | 					<xs:element ref="server" />
157 | 					<xs:element ref="server-ref" />
158 | 				</xs:choice>
159 | 				<xs:element name="url" type="url" maxOccurs="unbounded">
160 | 					<xs:annotation>
161 | 						<xs:documentation>Give the endpoint details along with the possible operations in this element.</xs:documentation>
162 | 					</xs:annotation>
163 | 					<xs:unique name="unique-operation-name">
164 | 						<xs:selector xpath="operation"></xs:selector>
165 | 						<xs:field xpath="@name"></xs:field>
166 | 					</xs:unique>
167 | 				</xs:element>
168 | 				<xs:element ref="authentication" minOccurs="0" maxOccurs="unbounded">
169 | 					<xs:annotation>
170 | 						<xs:documentation>Give details related to the authentication of an operation or resource.</xs:documentation>
171 | 					</xs:annotation>
172 | 				</xs:element>
173 | 				<xs:element name="authentication-schema" minOccurs="0">
174 | 					<xs:annotation>
175 | 						<xs:documentation>Give details about the authentication type for the opertation and the related URLs in this element.</xs:documentation>
176 | 					</xs:annotation>
177 | 					<xs:complexType>
178 | 						<xs:choice maxOccurs="unbounded">
179 | 							<xs:element ref="token" />
180 | 							<xs:element ref="token-ref" />
181 | 							<xs:element ref="oauth2" />
182 | 							<xs:element ref="oauth2-ref" />
183 | 						</xs:choice>
184 | 					</xs:complexType>
185 | 				</xs:element>
186 | 				<xs:element name="dependency" minOccurs="0">
187 | 					<xs:annotation>
188 | 						<xs:documentation>This element is <b>mandatory</b> only when you have used the <b>data of another resource</b> in your current resource.</xs:documentation>
189 | 					</xs:annotation>
190 | 					<xs:complexType>
191 | 						<xs:attribute name="resources" type="xs:string" use="required">
192 | 							<xs:annotation>
193 | 								<xs:documentation>Specify the name of the dependent resource.</xs:documentation>
194 | 							</xs:annotation>
195 | 						</xs:attribute>
196 | 					</xs:complexType>
197 | 				</xs:element>
198 | 			</xs:sequence>
199 | 			<xs:attribute name="product" type="name-string" use="required">
200 | 				<xs:annotation>
201 | 					<xs:documentation>Mention the name of the product that you choose in ZEST UI.</xs:documentation>
202 | 				</xs:annotation>
203 | 			</xs:attribute>
204 | 			<xs:attribute name="name" type="resource-string" use="required">
205 | 				<xs:annotation>
206 | 					<xs:documentation>Give a name for the resource and this name should be unique for a particular product.</xs:documentation>
207 | 				</xs:annotation>
208 | 			</xs:attribute>
209 | 			<xs:attribute name="file-version" type="xs:string" />
210 | 			<xs:attributeGroup ref="spec-version" />
211 | 			<xs:attribute name="pre-loaded" type="xs:boolean" use="required">
212 | 				<xs:annotation>
213 | 					<xs:documentation>If the resource has data at initial state (when the new account is created) mention true, otherwise mention false.</xs:documentation>
214 | 				</xs:annotation>
215 | 			</xs:attribute>
216 | 			<xs:attribute ref="visibility" />
217 | 			<xs:anyAttribute processContents="lax" />
218 | 		</xs:complexType>
219 | 		<xs:unique name="unique-server">
220 | 			<xs:selector xpath="server|server-ref"></xs:selector>
221 | 			<xs:field xpath="@name"></xs:field>
222 | 		</xs:unique>
223 | 		<xs:unique name="unique-url-path">
224 | 			<xs:selector xpath="url"></xs:selector>
225 | 			<xs:field xpath="@path"></xs:field>
226 | 		</xs:unique>
227 | 	</xs:element>
228 | </xs:schema>


--------------------------------------------------------------------------------
/spec-studio/1_0_0/travelbureau/v1/specifications/commons.xml:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="UTF-8"?>
  2 | <resource name="commons" product="travelbureau" pre-loaded="true" specification="1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../xsd/spec.xsd">
  3 |     <components>
  4 |         <!-- Success Response & Structures -->
  5 |         <structure ref-name="SuccessActionResponse" cases="Success">
  6 |             <property name="code" type="string" values="SUCCESS" required-for="response">
  7 |                 <description>Denotes whether the API call was successfully processed.</description>
  8 |             </property>
  9 |             <property name="status" type="string" values="success" required-for="response">
 10 |                 <description>Represents the status of the API call.</description>
 11 |             </property>
 12 |             <property name="details" type="map" required-for="response">
 13 |                 <structure>
 14 |                     <property name="id" type="long_string" required-for="response" />
 15 |                 </structure>
 16 |             </property>
 17 |         </structure>
 18 | 
 19 |         <structure name="ActionResponse" ref-name="DeleteActionResponse" extend="SuccessActionResponse">
 20 |             <property name="message" type="string" values="Record Deleted" required-for="response">
 21 |                 <description>Represents the status of the API call.</description>
 22 |             </property>
 23 |         </structure>
 24 | 
 25 |         <response name="CreateSuccess" status="201">
 26 |             <description>This is the success response for CREATE operation of this resource.</description>
 27 |             <content>
 28 |                 <encode type="application/json"/>
 29 |                 <path-config data-extraction-path="$.details" />
 30 |                 <structure name="ActionResponse" extend="SuccessActionResponse">
 31 |                     <property name="message" type="string" values="Record Created" required-for="response">
 32 |                         <description>Details about result of the API call.</description>
 33 |                     </property>
 34 |                 </structure>
 35 |             </content>
 36 |         </response>
 37 | 
 38 |         <response name="UpdateSuccess" status="200">
 39 |             <description>This is the success response for UPDATE operation of this resource.</description>
 40 |             <content>
 41 |                 <encode type="application/json"/>
 42 |                 <path-config data-extraction-path="$.details" />
 43 |                 <structure name="ActionResponse" extend="SuccessActionResponse">
 44 |                     <property name="message" type="string" values="Record Updated" required-for="response">
 45 |                         <description>Represents the status of the API call.</description>
 46 |                     </property>
 47 |                 </structure>
 48 |             </content>
 49 |         </response>
 50 | 
 51 |         <!-- Error Response & Structures -->
 52 |         <structure ref-name="ErrorActionResponse">
 53 |             <property name="details" type="map" required-for="response">
 54 |                 <description>Provides the error details.</description>
 55 |                 <structure>
 56 |                     <property name="api_name" type="string" required-for="response">
 57 |                         <description>The key name in which the error occurred.</description>
 58 |                     </property>
 59 |                     <property name="json_path" type="string" required-for="response">
 60 |                         <description>Holds the JSON path of the key in which the error occured.</description>
 61 |                     </property>
 62 |                 </structure>
 63 |             </property>
 64 |             <property name="status" type="string" values="error" required-for="response">
 65 |                 <description>Represents the status of the API call.</description>
 66 |             </property>
 67 |         </structure>
 68 | 
 69 |         <structure name="ActionResponse" ref-name="MandatoryNotFoundActionResponse" extend="ErrorActionResponse" cases="Mandatory,Null">
 70 |             <property name="code" type="string" values="MANDATORY_NOT_FOUND">
 71 |                 <description>The API call is a failure as the mandatory keys were not provided.</description>
 72 |             </property>
 73 |             <property name="message" type="string" values="Required field not found">
 74 |                 <description>Provide the mandatory keys as specified in the request JSON keys.</description>
 75 |             </property>
 76 |         </structure>
 77 | 
 78 |         <structure name="ActionResponse" ref-name="InvalidRequestBodyActionResponse" extend="ErrorActionResponse" cases="InvalidValue,MaxLength,MinLength,EmptyRoot,EmptyValue,Regex">
 79 |             <property name="code" required-for="all" type="string" values="INVALID_DATA"/>
 80 |             <property name="message" required-for="all" type="string" values="The given data is invalid"/>
 81 |         </structure>
 82 | 
 83 |         <structure name="ActionResponse" ref-name="DuplicateDataActionResponse" extend="ErrorActionResponse" cases="Unique">
 84 |             <property name="code" type="string" values="DUPLICATE_DATA" required-for="response">
 85 |                 <description>The API call was a failure due to duplicate values in unique keys.</description>
 86 |             </property>
 87 |             <property name="message" type="string" values="Record already exists" required-for="response">
 88 |                 <description>You have provided a duplicate value for a key. Check for the request JSON keys to know the unique keys and provide a valide value. </description>
 89 |             </property>
 90 |         </structure>
 91 | 
 92 |         <structure name="ActionResponse" ref-name="InvalidDataTypeActionResponse" extend="ErrorActionResponse" cases="InvalidType">
 93 |             <property name="code" type="string" values="INVALID_DATA" required-for="response">
 94 |                 <description>The API call failed due to invalid data in the request payload.</description>
 95 |             </property>
 96 |             <property name="message" type="string" values="The given data type is invalid" required-for="response">
 97 |                 <description>You have provided an invalid data type value for a key. Provide a valid input that satisfies the data type denoted in the request JSON keys section.</description>
 98 |             </property>
 99 |         </structure>
100 | 
101 |         <response name="InvalidParamResponse" status="400">
102 |             <content>
103 |                 <encode type="application/json" />
104 |                 <structure name="ActionResponse" extend="ErrorActionResponse" cases="EmptyParam,InvalidParam">
105 |                     <property name="code" type="string" values="INVALID_DATA" required-for="response">
106 |                         <description>The API call failed due to an invalid data.</description>
107 |                     </property>
108 |                     <property name="message" type="string" values="The given param value is invalid" required-for="response">
109 |                         <description>You have given an invalid value in the request parameter.</description>
110 |                     </property>
111 |                     <property name="details" type="map" required-for="response">
112 |                         <structure>
113 |                             <property name="param_name" type="string" required-for="response" example-value="ids">
114 |                                 <description>The invalid parameter name.</description>
115 |                             </property>
116 |                         </structure>
117 |                     </property>
118 |                 </structure>
119 |             </content>
120 |         </response>
121 | 
122 |         <response name="ResourceNotFoundResponse" status="404">
123 |             <content>
124 |                 <encode type="application/json" />
125 |                 <structure name="ActionResponse" extend="ErrorActionResponse" cases="InvalidValueInURLPath">
126 |                     <property name="code" type="string" values="NOT_FOUND" required-for="response">
127 |                         <description>The API call failed due to an invalid request url.</description>
128 |                     </property>
129 |                     <property name="message" type="string" values="You have specified an invalid data in the URL." required-for="response">
130 |                         <description>You have given an invalid value in the URL. Refer to the server and endpoints section and provide a valid URL.</description>
131 |                     </property>
132 |                     <property name="details" type="map" required-for="response">
133 |                         <structure>
134 |                             <property name="resource_path_index" type="integer" required-for="response" example-value="1" />
135 |                         </structure>
136 |                     </property>
137 |                 </structure>
138 |             </content>
139 |         </response>
140 | 
141 |         <response name="BadRequest" status="400">
142 |             <description>Following is a list of possible errors that could be made from the client side.</description>
143 |             <content>
144 |                 <encode type="application/json"/>
145 |                 <structure-group name="ErrorActionResponse" type="one-of">
146 |                     <structure-ref name="MandatoryNotFoundActionResponse"/>
147 |                     <structure-ref name="InvalidRequestBodyActionResponse" />
148 |                     <structure-ref name="DuplicateDataActionResponse"/>
149 |                     <structure-ref name="InvalidDataTypeActionResponse"/>
150 |                 </structure-group>
151 |             </content>
152 |         </response>
153 | 
154 |         <!--  Auth Schema & its components -->
155 |         <argument name="client_id" location="param" required="true">
156 |             <description>Client ID(consumer key) that you obtained during client registration.</description>
157 |             <content>
158 |                 <encode type="text/plain"/>
159 |                 <structure>
160 |                     <property type="string"/>
161 |                 </structure>
162 |             </content>
163 |         </argument>
164 |         <argument name="redirect_uri" location="param" required="true">
165 |             <description>Callback URL that you specified during client registration.</description>
166 |             <content>
167 |                 <encode type="text/plain"/>
168 |                 <structure>
169 |                     <property type="string"/>
170 |                 </structure>
171 |             </content>
172 |         </argument>
173 |         <argument name="client_secret" location="param" required="true">
174 |             <description>Specify client secret obtained from the connected app.</description>
175 |             <content>
176 |                 <encode type="text/plain"/>
177 |                 <structure>
178 |                     <property type="string"/>
179 |                 </structure>
180 |             </content>
181 |         </argument>
182 | 
183 |         <structure ref-name="AccessToken">
184 |             <property name="access_token" type="string" required-for="response">
185 |                 <description>Access token to access TravelBureau APIs.</description>
186 |             </property>
187 |             <property name="expires_in" type="string" values="3600" required-for="response">
188 |                 <description>Time in seconds after which the access token expires.</description>
189 |             </property>
190 |             <property name="api_domain" type="string" required-for="response">
191 |                 <description>Domain name of the API. Use this domain in your requests to make API calls to Travel Bureau.</description>
192 |             </property>
193 |             <property name="token_type" type="string" values="Bearer" required-for="response">
194 |                 <description>Type of token obtained. "Bearer" indicates this is an access token.</description>
195 |             </property>
196 |         </structure>
197 | 
198 |         <oauth2 name="OAuth2Schema">
199 |             <authorization-url path="https://accounts.travel_bureau.com/oauth/v2/auth">
200 |                 <operation category="action" method="get" name="Authorization Request">
201 |                     <description>To use the Travel Bureau APIs, the users must authenticate the application to make API calls on their behalf with an access token.</description>
202 | 
203 |                     <argument name="scope" location="param" required="true">
204 |                         <description>Data that your application wants to access.</description>
205 |                         <content>
206 |                             <encode type="text/plain"/>
207 |                             <structure>
208 |                                 <property type="string"/>
209 |                             </structure>
210 |                         </content>
211 |                     </argument>
212 |                     <argument-ref name="client_id"/>
213 |                     <argument name="response_type" location="param" required="true">
214 |                         <description>It decides the type of response.</description>
215 |                         <content>
216 |                             <encode type="text/plain"/>
217 |                             <structure>
218 |                                 <property type="string" values="code"/>
219 |                             </structure>
220 |                         </content>
221 |                     </argument>
222 |                     <argument name="access_type" location="param" required="true">
223 |                         <description>Enter access_type as online or offline.</description>
224 |                         <content>
225 |                             <encode type="text/plain"/>
226 |                             <structure>
227 |                                 <property type="string" values="offline,online"/>
228 |                             </structure>
229 |                         </content>
230 |                     </argument>
231 |                     <argument-ref name="redirect_uri"/>
232 | 
233 |                     <response status="200"/>
234 |                 </operation>
235 |             </authorization-url>
236 | 
237 |             <token-url path="https://accounts.travel_bureau.com/oauth/v2/token">
238 |                 <operation category="action" method="post" name="Generate Access Token and Refresh Token">
239 |                     <description>OAuth2.0 requests are usually authenticated with an access token, which is passed as bearer token. To use this access token, you need to construct a normal HTTP request and include it in an Authorization header along with the value of Bearer.</description>
240 | 
241 |                     <argument name="grant_type" location="param" required="true">
242 |                         <description>It is crucial to select the appropriate grant type to ensure the security and integrity of the authentication and authorization process. Thus, the only possible value is **authorization_code**.</description>
243 |                         <content>
244 |                             <encode type="text/plain"/>
245 |                             <structure>
246 |                                 <property type="string" values="authorization_code"/>
247 |                             </structure>
248 |                         </content>
249 |                     </argument>
250 |                     <argument-ref name="client_id"/>
251 |                     <argument-ref name="client_secret"/>
252 |                     <argument name="code" location="param" required="true">
253 |                         <description>Enter the grant token generated from authorization.</description>
254 |                         <content>
255 |                             <encode type="text/plain"/>
256 |                             <structure>
257 |                                 <property type="string"/>
258 |                             </structure>
259 |                         </content>
260 |                     </argument>
261 |                     <argument-ref name="redirect_uri"/>
262 | 
263 |                     <response status="200">
264 |                         <content>
265 |                             <encode type="application/json"/>
266 |                             <structure name="RefreshToken" extend="AccessToken">
267 |                                 <property name="refresh_token" type="string">
268 |                                     <description>Refresh token to obtain new access tokens.</description>
269 |                                 </property>
270 |                             </structure>
271 |                         </content>
272 |                     </response>
273 |                 </operation>
274 |             </token-url>
275 | 
276 |             <refresh-url path="https://accounts.travel_bureau.com/oauth/v2/token">
277 |                 <operation category="action" method="post" name="Refresh Access Token">
278 |                     <description>Access tokens expire after an hour of generation. To generate a new access token, use the refresh token you generated earlier.</description>
279 | 
280 |                     <argument name="refresh_token" location="param" required="true">
281 |                         <description>Provide the refresh token received using the token URL.</description>
282 |                         <content>
283 |                             <encode type="text/plain"/>
284 |                             <structure>
285 |                                 <property type="string"/>
286 |                             </structure>
287 |                         </content>
288 |                     </argument>
289 |                     <argument-ref name="client_id"/>
290 |                     <argument-ref name="client_secret"/>
291 |                     <argument name="grant_type" location="param" required="true">
292 |                         <description>It is crucial to select the appropriate grant type to ensure the security and integrity of the authentication and authorization process. Thus, the only possible value is **refresh_token**.</description>
293 |                         <content>
294 |                             <encode type="text/plain"/>
295 |                             <structure>
296 |                                 <property type="string" values="refresh_token"/>
297 |                             </structure>
298 |                         </content>
299 |                     </argument>
300 | 
301 |                     <response status="200">
302 |                         <content>
303 |                             <encode type="application/json"/>
304 |                             <structure-ref name="AccessToken" />
305 |                         </content>
306 |                     </response>
307 |                 </operation>
308 |             </refresh-url>
309 | 
310 |             <authentication-url path="https://accounts.travel_bureau.com/oauth/user/info">
311 |                 <operation category="action" method="get" name="Check Access Token">
312 |                     <description>This URL will authenticate the token and identifies the user.</description>
313 |                     <response status="200">
314 |                         <content>
315 |                             <encode type="application/json"/>
316 |                             <structure name="UserInfo">
317 |                                 <property name="Id" type="long_string" required-for="response">
318 |                                     <description>The User ID of the user.</description>
319 |                                 </property>
320 |                                 <property name="Email" type="string" required-for="response">
321 |                                     <description>Email ID of the user.</description>
322 |                                 </property>
323 |                                 <property name="First_Name" type="string" required-for="response">
324 |                                     <description>First Name of the user.</description>
325 |                                 </property>
326 |                                 <property name="Last_Name" type="string" required-for="response">
327 |                                     <description>Last Name of the user.</description>
328 |                                 </property>
329 |                                 <property name="Display_Name" type="string" required-for="response">
330 |                                     <description>The display name of the user.</description>
331 |                                 </property>
332 |                             </structure>
333 |                         </content>
334 |                     </response>
335 |                 </operation>
336 |             </authentication-url>
337 |         </oauth2>
338 | 
339 |         <!-- Server -->
340 |         <server dc="US" name="TravelBureauAPIServer" url="https://travelbureauapis.com">
341 |             <description>Travel Bureau is hosted only in the US data center. Powering our travel services, this server provides swift access to destination details, booking services, real-time weather updates, and personalized itinerary planning. Explore the API's capabilities and integrate seamlessly into your applications for an enhanced travel experience. </description>
342 | 
343 |             <environment location="header" name="env" type="development" value="DEVELOPMENT">
344 |                 <description>Development of products takes place in this environment. Specify this parameter to use the resource in development environment.</description>
345 |             </environment>
346 |             <environment location="header" name="env" type="sandbox" value="SANDBOX">
347 |                 <description>Sandbox is an isolated environment, which helps you to test the product without affecting the application.</description>
348 |             </environment>
349 |         </server>
350 | 
351 |         <!-- Info -->
352 |         <contact-details name="Travel Bureau Support" email="support@travelbureau.com" url="https://www.travel_bureau.com/resources/support-plans.html"/>
353 |         <terms-of-service name="Terms and Conditions">This API sternly follows the data usage and privacy policy, API Access Agreement, liability and indemnification. These terms of services are subject to modification and updates.</terms-of-service>
354 |         <license-details name="Apache License 2" url="https://www.apache.org/licenses/LICENSE-2.0"/>
355 |     </components>
356 | 
357 |     <info title="Common components" version="1">
358 |         <description>Common components</description>
359 |     </info>
360 | 
361 |     <resource-config>
362 |         <path-config data-extraction-path="$" />
363 |     </resource-config>
364 | 
365 |     <server-ref name="TravelBureauAPIServer"/>
366 | 
367 |     <url path="/">
368 |         <operation category="read" method="get" name="Get Home Page">
369 |             <response status="200" />
370 |         </operation>
371 |     </url>
372 | </resource>
373 | 


--------------------------------------------------------------------------------
/spec-studio/1_0_0/xsd/components.xsd:
--------------------------------------------------------------------------------
   1 | <?xml version="1.0" encoding="UTF-8"?>
   2 | <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
   3 | 	<xs:element name="components">
   4 | 		<xs:annotation>
   5 | 			<xs:documentation>This element acts as a storage container for other elements that can be reused within a resource and across multiple resources. It reduces the recurrence of similar tags, optimising the long-winded files with conciser codes. All the child elements of components should have the ref-name attribute with unique value. Whenever you want to reuse that child element, enter the value of ref-name in the name attribute of corresponding ref element.</xs:documentation>
   6 | 		</xs:annotation>
   7 | 		<xs:complexType>
   8 | 			<xs:complexContent>
   9 | 				<xs:extension base="components">
  10 | 					<xs:attribute name="product" type="name-string" use="required">
  11 | 						<xs:annotation>
  12 | 							<xs:documentation>Mention the name of the product that you choose in ZEST UI.</xs:documentation>
  13 | 						</xs:annotation>
  14 | 					</xs:attribute>
  15 | 					<xs:attribute name="version" type="version-string" use="required">
  16 | 						<xs:annotation>
  17 | 							<xs:documentation>Mention the version in which you want to refer the global components.</xs:documentation>
  18 | 						</xs:annotation>
  19 | 					</xs:attribute>
  20 | 					<xs:attributeGroup ref="spec-version" />
  21 | 				</xs:extension>
  22 | 			</xs:complexContent>
  23 | 		</xs:complexType>
  24 | 	</xs:element>
  25 | 
  26 | 	<xs:attributeGroup name="spec-version">
  27 | 		<xs:attribute name="specification" use="required">
  28 | 			<xs:annotation>
  29 | 				<xs:documentation>Mention the xsd version of ZEST Specification Format.</xs:documentation>
  30 | 			</xs:annotation>
  31 | 			<xs:simpleType>
  32 | 				<xs:restriction base="xs:string">
  33 | 					<xs:enumeration value="1.0.0" />
  34 | 				</xs:restriction>
  35 | 			</xs:simpleType>
  36 | 		</xs:attribute>
  37 | 	</xs:attributeGroup>
  38 | 
  39 | 	<xs:complexType name="components">
  40 | 		<xs:choice maxOccurs="unbounded">
  41 | 			<xs:element name="example">
  42 | 				<xs:annotation>
  43 | 					<xs:documentation>Give example contents for the request/response body in this element. This will be added to the <b>help documentation</b>.</xs:documentation>
  44 | 				</xs:annotation>
  45 | 				<xs:complexType>
  46 | 					<xs:complexContent>
  47 | 						<xs:extension base="example">
  48 | 							<xs:attribute name="name" type="name-string" use="required">
  49 | 								<xs:annotation>
  50 | 									<xs:documentation>Give a name for the sample request/response of the API.</xs:documentation>
  51 | 								</xs:annotation>
  52 | 							</xs:attribute>
  53 | 						</xs:extension>
  54 | 					</xs:complexContent>
  55 | 				</xs:complexType>
  56 | 			</xs:element>
  57 | 
  58 | 			<xs:element name="structure" type="ref-structure">
  59 | 				<xs:annotation>
  60 | 					<xs:documentation>Give the structural information of the body of request / response / argument.</xs:documentation>
  61 | 				</xs:annotation>
  62 | 				<xs:unique name="unique-ref-structure-property-name">
  63 | 					<xs:selector xpath="property"></xs:selector>
  64 | 					<xs:field xpath="@name"></xs:field>
  65 | 				</xs:unique>
  66 | 				<xs:unique name="unique-ref-structure-property-name-regex">
  67 | 					<xs:selector xpath="property"></xs:selector>
  68 | 					<xs:field xpath="@name-regex"></xs:field>
  69 | 				</xs:unique>
  70 | 			</xs:element>
  71 | 
  72 | 			<xs:element name="content">
  73 | 				<xs:annotation>
  74 | 					<xs:documentation>Give details about the content of response/request-body/argument.</xs:documentation>
  75 | 				</xs:annotation>
  76 | 				<xs:complexType>
  77 | 					<xs:complexContent>
  78 | 						<xs:extension base="content">
  79 | 							<xs:attribute name="name" type="name-string" use="required">
  80 | 								<xs:annotation>
  81 | 									<xs:documentation>Give a name for the content.</xs:documentation>
  82 | 								</xs:annotation>
  83 | 							</xs:attribute>
  84 | 						</xs:extension>
  85 | 					</xs:complexContent>
  86 | 				</xs:complexType>
  87 | 			</xs:element>
  88 | 
  89 | 			<xs:element ref="argument" />
  90 | 
  91 | 			<xs:element name="request-body">
  92 | 				<xs:annotation>
  93 | 					<xs:documentation>Mention the request-body details for your operation.</xs:documentation>
  94 | 				</xs:annotation>
  95 | 				<xs:complexType>
  96 | 					<xs:complexContent>
  97 | 						<xs:extension base="request-body">
  98 | 							<xs:attribute name="name" type="name-string" use="required">
  99 | 								<xs:annotation>
 100 | 									<xs:documentation>Give a name for the request-body.</xs:documentation>
 101 | 								</xs:annotation>
 102 | 							</xs:attribute>
 103 | 						</xs:extension>
 104 | 					</xs:complexContent>
 105 | 				</xs:complexType>
 106 | 			</xs:element>
 107 | 
 108 | 			<xs:element name="response">
 109 | 				<xs:annotation>
 110 | 					<xs:documentation>Response tag defines the response related information for a particular API. Response can be of multiple encodings. This can be defined by providing another content tag with different encoding.</xs:documentation>
 111 | 				</xs:annotation>
 112 | 				<xs:complexType>
 113 | 					<xs:complexContent>
 114 | 						<xs:extension base="response">
 115 | 							<xs:attribute name="name" type="name-string" use="required">
 116 | 								<xs:annotation>
 117 | 									<xs:documentation>State the name of the response.</xs:documentation>
 118 | 								</xs:annotation>
 119 | 							</xs:attribute>
 120 | 						</xs:extension>
 121 | 					</xs:complexContent>
 122 | 				</xs:complexType>
 123 | 				<xs:unique name="unique-response-component-argument-name">
 124 | 					<xs:selector xpath="argument|argument-ref"></xs:selector>
 125 | 					<xs:field xpath="@name"></xs:field>
 126 | 				</xs:unique>
 127 | 			</xs:element>
 128 | 
 129 | 			<xs:element ref="server" />
 130 | 
 131 | 			<xs:element name="terms-of-service">
 132 | 				<xs:annotation>
 133 | 					<xs:documentation>Give the details of terms of service of the API as an <b>MD String</b>.</xs:documentation>
 134 | 				</xs:annotation>
 135 | 				<xs:complexType>
 136 | 					<xs:simpleContent>
 137 | 						<xs:extension base="xs:string">
 138 | 							<xs:attribute name="name" type="name-string">
 139 | 								<xs:annotation>
 140 | 									<xs:documentation>Give a name for the terms of service.</xs:documentation>
 141 | 								</xs:annotation>
 142 | 							</xs:attribute>
 143 | 						</xs:extension>
 144 | 					</xs:simpleContent>
 145 | 				</xs:complexType>
 146 | 			</xs:element>
 147 | 
 148 | 			<xs:element name="contact-details" type="contact-details">
 149 | 				<xs:annotation>
 150 | 					<xs:documentation>Provide the contact information for <b>help documentation</b> or reach out for assistance. This content will be added to the help documentation.</xs:documentation>
 151 | 				</xs:annotation>
 152 | 			</xs:element>
 153 | 
 154 | 			<xs:element ref="license-details" />
 155 | 
 156 | 			<xs:element ref="token" />
 157 | 
 158 | 			<xs:element ref="oauth2" />
 159 | 
 160 | 			<xs:element name="throttling">
 161 | 				<xs:annotation>
 162 | 					<xs:documentation>You can specify the number of possible requests for the specified duration for a particular operation.</xs:documentation>
 163 | 				</xs:annotation>
 164 | 				<xs:complexType>
 165 | 					<xs:complexContent>
 166 | 						<xs:extension base="throttling">
 167 | 							<xs:attribute name="name" type="name-string" use="required">
 168 | 								<xs:annotation>
 169 | 									<xs:documentation>Name of throttling.</xs:documentation>
 170 | 								</xs:annotation>
 171 | 							</xs:attribute>
 172 | 						</xs:extension>
 173 | 					</xs:complexContent>
 174 | 				</xs:complexType>
 175 | 			</xs:element>
 176 | 
 177 | 			<xs:element ref="tag" />
 178 | 			
 179 | 		</xs:choice>
 180 | 	</xs:complexType>
 181 | 
 182 | 	<xs:attribute name="visibility" type="visibility" default="public">
 183 | 		<xs:annotation>
 184 | 			<xs:documentation>Specify the visibility. The possible values are internal, private, public.</xs:documentation>
 185 | 		</xs:annotation>
 186 | 	</xs:attribute>
 187 | 
 188 | 	<xs:element name="description" type="xs:string">
 189 | 		<xs:annotation>
 190 | 			<xs:documentation>Give information about the element. This description will be added to the help document. This element type is <b>String(MD)</b></xs:documentation>
 191 | 		</xs:annotation>
 192 | 	</xs:element>
 193 | 
 194 | 	<xs:simpleType name="any-string">
 195 | 		<xs:restriction base="xs:string">
 196 | 			<xs:pattern value=".*[^\s].*"/>
 197 | 			<xs:maxLength value="255" />
 198 | 		</xs:restriction>
 199 | 	</xs:simpleType>
 200 | 
 201 | 	<xs:simpleType name="name-string">
 202 | 		<xs:restriction base="xs:string">
 203 | 			<xs:pattern value="[^.]+" />
 204 | 			<xs:maxLength value="255" />
 205 | 		</xs:restriction>
 206 | 	</xs:simpleType>
 207 | 
 208 | 	<xs:simpleType name="ref-name-string">
 209 | 		<xs:restriction base="xs:string">
 210 | 			<!-- Resource name max (200) + dot + Component name max (255) -->
 211 | 			<xs:maxLength value="456" />
 212 | 		</xs:restriction>
 213 | 	</xs:simpleType>
 214 | 
 215 | 	<xs:simpleType name="resource-string">
 216 | 		<xs:restriction base="xs:string">
 217 | 			<xs:pattern value="[a-zA-Z][a-zA-Z0-9_-]*" />
 218 | 			<xs:maxLength value="200" />
 219 | 		</xs:restriction>
 220 | 	</xs:simpleType>
 221 | 
 222 | 	<xs:simpleType name="version-string">
 223 | 		<xs:restriction base="xs:string">
 224 | 			<xs:pattern value="(0|[1-9]\d{0,8})(\.(0|[1-9]\d{0,8})){0,2}" />
 225 | 			<xs:maxLength value="60" />
 226 | 		</xs:restriction>
 227 | 	</xs:simpleType>
 228 | 
 229 | 	<xs:element name="tag">
 230 | 		<xs:annotation>
 231 | 			<xs:documentation>In API help documentation, multiple operations can be grouped under a single tag name, based on the details you mention in this element.</xs:documentation>
 232 | 		</xs:annotation>
 233 | 		<xs:complexType>
 234 | 			<xs:sequence>
 235 | 				<xs:element ref="description" minOccurs="0" />
 236 | 			</xs:sequence>
 237 | 			<xs:attribute name="name" type="name-string" use="required">
 238 | 				<xs:annotation>
 239 | 					<xs:documentation>Mention the name of the tag to be used in the help document.</xs:documentation>
 240 | 				</xs:annotation>
 241 | 			</xs:attribute>
 242 | 			<xs:attribute ref="visibility" />
 243 | 		</xs:complexType>
 244 | 	</xs:element>
 245 | 
 246 | 	<xs:element name="tag-ref">
 247 | 		<xs:annotation>
 248 | 			<xs:documentation>Refer tag from local components / other resources / global component.</xs:documentation>
 249 | 		</xs:annotation>
 250 | 		<xs:complexType>
 251 | 			<xs:attribute name="name" type="ref-name-string" use="required">
 252 | 				<xs:annotation>
 253 | 					<xs:documentation>Provide the name of the tag specifiecd in the components.</xs:documentation>
 254 | 				</xs:annotation>
 255 | 			</xs:attribute>
 256 | 		</xs:complexType>
 257 | 	</xs:element>
 258 | 
 259 | 	<xs:complexType name="url">
 260 | 		<xs:annotation>
 261 | 			<xs:documentation>Give the <b>endpoint details</b> along with the <b>possible operations</b> in this element.</xs:documentation>
 262 | 		</xs:annotation>
 263 | 		<xs:sequence>
 264 | 			<xs:element name="operation" maxOccurs="unbounded">
 265 | 				<xs:annotation>
 266 | 					<xs:documentation>Define the <b>possible operations</b> of the API for a particular <b>URL</b>.</xs:documentation>
 267 | 				</xs:annotation>
 268 | 				<xs:complexType>
 269 | 					<xs:sequence>
 270 | 						<xs:element ref="deprecate" minOccurs="0">
 271 | 							<xs:annotation>
 272 | 								<xs:documentation>Provide the <b>deprecation details</b> (i.e., the outdated or no longer supported information) of the API.</xs:documentation>
 273 | 							</xs:annotation>
 274 | 						</xs:element>
 275 | 						<xs:element ref="description" minOccurs="0" />
 276 | 						<xs:choice minOccurs="0" maxOccurs="unbounded">
 277 | 							<xs:element name="throttling" type="throttling">
 278 | 								<xs:annotation>
 279 | 									<xs:documentation>You can specify the number of possible requests for the specified duration for a particular operation.</xs:documentation>
 280 | 								</xs:annotation>
 281 | 							</xs:element>
 282 | 							<xs:element ref="throttling-ref" />
 283 | 						</xs:choice>
 284 | 						<xs:element name="external-document" minOccurs="0">
 285 | 							<xs:annotation>
 286 | 								<xs:documentation>Mention the links to external documents that needs to be added to the help document.</xs:documentation>
 287 | 							</xs:annotation>
 288 | 							<xs:complexType>
 289 | 								<xs:sequence>
 290 | 									<xs:element ref="description" minOccurs="0" />
 291 | 								</xs:sequence>
 292 | 								<xs:attribute name="url" type="xs:anyURI" use="required">
 293 | 									<xs:annotation>
 294 | 										<xs:documentation>Mention the external URL to be added to the help document.</xs:documentation>
 295 | 									</xs:annotation>
 296 | 								</xs:attribute>
 297 | 							</xs:complexType>
 298 | 						</xs:element>
 299 | 						<xs:choice minOccurs="0" maxOccurs="unbounded">
 300 | 							<xs:element ref="tag">
 301 | 								<xs:annotation>
 302 | 									<xs:documentation>In API help documentation, multiple operations can be grouped under a single tag name, based on the details you mention in this element.</xs:documentation>
 303 | 								</xs:annotation>
 304 | 							</xs:element>
 305 | 							<xs:element ref="tag-ref" />
 306 | 						</xs:choice>
 307 | 						<xs:element ref="error" minOccurs="0" />
 308 | 						<xs:choice minOccurs="0" maxOccurs="unbounded">
 309 | 							<xs:element ref="argument" />
 310 | 							<xs:element ref="argument-ref" />
 311 | 						</xs:choice>
 312 | 						<xs:choice minOccurs="0" maxOccurs="unbounded">
 313 | 							<xs:element name="request-body" type="request-body">
 314 | 								<xs:annotation>
 315 | 									<xs:documentation>Mention the request-body details for your operation.</xs:documentation>
 316 | 								</xs:annotation>
 317 | 							</xs:element>
 318 | 							<xs:element ref="request-body-ref" />
 319 | 						</xs:choice>
 320 | 						<xs:choice maxOccurs="unbounded">
 321 | 							<xs:element name="response">
 322 | 								<xs:annotation>
 323 | 									<xs:documentation>Response tag defines the response related information for a particular API. Response can be of multiple encodings. This can be defined by providing another content tag with different encoding.</xs:documentation>
 324 | 								</xs:annotation>
 325 | 								<xs:complexType>
 326 | 									<xs:complexContent>
 327 | 										<xs:extension base="response">
 328 | 											<xs:attribute name="name" type="name-string">
 329 | 												<xs:annotation>
 330 | 													<xs:documentation>State the name of the response.</xs:documentation>
 331 | 												</xs:annotation>
 332 | 											</xs:attribute>
 333 | 										</xs:extension>
 334 | 									</xs:complexContent>
 335 | 								</xs:complexType>
 336 | 								<xs:unique name="unique-response-argument-name">
 337 | 									<xs:selector xpath="argument|argument-ref"></xs:selector>
 338 | 									<xs:field xpath="@name"></xs:field>
 339 | 								</xs:unique>
 340 | 							</xs:element>
 341 | 							<xs:element ref="response-ref" />
 342 | 						</xs:choice>
 343 | 						<xs:element ref="authentication" minOccurs="0" maxOccurs="unbounded" />
 344 | 					</xs:sequence>
 345 | 					<xs:attribute name="method" use="required">
 346 | 						<xs:annotation>
 347 | 							<xs:documentation>Select the HTTP method that is applicable for the API operation. The http methods are <b>get, post, put, patch and delete</b>.</xs:documentation>
 348 | 						</xs:annotation>
 349 | 						<xs:simpleType>
 350 | 							<xs:restriction base="xs:string">
 351 | 								<xs:enumeration value="get" />
 352 | 								<xs:enumeration value="post" />
 353 | 								<xs:enumeration value="put" />
 354 | 								<xs:enumeration value="patch" />
 355 | 								<xs:enumeration value="delete" />
 356 | 							</xs:restriction>
 357 | 						</xs:simpleType>
 358 | 					</xs:attribute>
 359 | 					<xs:attribute name="name" type="name-string" use="required">
 360 | 						<xs:annotation>
 361 | 							<xs:documentation>Give a name for the operation and it should be unique in that ZSPEC file/Resource.</xs:documentation>
 362 | 						</xs:annotation>
 363 | 					</xs:attribute>
 364 | 					<xs:attribute name="category" use="required">
 365 | 						<xs:annotation>
 366 | 							<xs:documentation>Defines the category of the operation. It'll be used while testing the API to find URLs based on the category. The possible values are <b>read, create, update, delete and action</b>.</xs:documentation>
 367 | 						</xs:annotation>
 368 | 						<xs:simpleType>
 369 | 							<xs:restriction base="xs:string">
 370 | 								<xs:enumeration value="read" />
 371 | 								<xs:enumeration value="create" />
 372 | 								<xs:enumeration value="update" />
 373 | 								<xs:enumeration value="delete" />
 374 | 								<xs:enumeration value="action" />
 375 | 							</xs:restriction>
 376 | 						</xs:simpleType>
 377 | 					</xs:attribute>
 378 | 					<xs:attribute name="delay" type="xs:long">
 379 | 						<xs:annotation>
 380 | 							<xs:documentation>Mention the time gap required for the current operator.</xs:documentation>
 381 | 						</xs:annotation>
 382 | 					</xs:attribute>
 383 | 					<xs:attribute name="validation-delay" type="xs:long">
 384 | 						<xs:annotation>
 385 | 							<xs:documentation>Mention the waiting time for the <b>call back requests</b>. For instance, consider you want to create a record and get details of the newly created record. Say your validation delay is 10s. Once the response for record creation is received, the GET Record call will be fired only after of 10 seconds. This will be used in the API Automation.</xs:documentation>
 386 | 						</xs:annotation>
 387 | 					</xs:attribute>
 388 | 					<xs:attribute ref="visibility" />
 389 | 					<xs:anyAttribute processContents="lax" />
 390 | 				</xs:complexType>
 391 | 				
 392 | 				<xs:unique name="unique-tag">
 393 | 					<xs:selector xpath="tag|tag-ref"></xs:selector>
 394 | 					<xs:field xpath="@name"></xs:field>
 395 | 				</xs:unique>
 396 | 				<xs:unique name="unique-argument">
 397 | 					<xs:selector xpath="argument|argument-ref"></xs:selector>
 398 | 					<xs:field xpath="@name"></xs:field>
 399 | 				</xs:unique>
 400 | 				<xs:unique name="unique-throttling-ref">
 401 | 					<xs:selector xpath="throttling-ref"></xs:selector>
 402 | 					<xs:field xpath="@name"></xs:field>
 403 | 				</xs:unique>
 404 | 			</xs:element>
 405 | 		</xs:sequence>
 406 | 		<xs:attribute name="path" type="xs:string" use="required">
 407 | 			<xs:annotation>
 408 | 				<xs:documentation>Give the URL path.</xs:documentation>
 409 | 			</xs:annotation>
 410 | 		</xs:attribute>
 411 | 		<xs:anyAttribute processContents="lax" />
 412 | 	</xs:complexType>
 413 | 
 414 | 	<xs:element name="path-config">
 415 | 		<xs:annotation>
 416 | 			<xs:documentation>Provide the path details from where the <b>data</b> and <b>primary keys</b> of the resource should be fetched.</xs:documentation>
 417 | 		</xs:annotation>
 418 | 		<xs:complexType>
 419 | 			<xs:sequence>
 420 | 				<xs:element name="primary" minOccurs="0" maxOccurs="unbounded">
 421 | 					<xs:annotation>
 422 | 						<xs:documentation>Using this tag , you can mention the path of the primary key relative to the path mentioned in the path-config.</xs:documentation>
 423 | 					</xs:annotation>
 424 | 					<xs:complexType>
 425 | 						<xs:attribute name="name" type="name-string">
 426 | 							<xs:annotation>
 427 | 								<xs:documentation>Give a name for the primary.</xs:documentation>
 428 | 							</xs:annotation>
 429 | 						</xs:attribute>
 430 | 						<xs:attribute name="path" type="xs:string" use="required">
 431 | 							<xs:annotation>
 432 | 								<xs:documentation>Mention the path of the primary key relative to the path mentioned in the path-config.</xs:documentation>
 433 | 							</xs:annotation>
 434 | 						</xs:attribute>
 435 | 					</xs:complexType>
 436 | 				</xs:element>
 437 | 			</xs:sequence>
 438 | 			<xs:attribute name="data-extraction-path" type="xs:string" use="required">
 439 | 				<xs:annotation>
 440 | 					<xs:documentation>Mention the JSON path to locate the root key.</xs:documentation>
 441 | 				</xs:annotation>
 442 | 			</xs:attribute>
 443 | 		</xs:complexType>
 444 | 	</xs:element>
 445 | 
 446 | 	<xs:element name="server">
 447 | 		<xs:annotation>
 448 | 			<xs:documentation>Give the <b>details of the domains</b> and DCs through which you can access the API.</xs:documentation>
 449 | 		</xs:annotation>
 450 | 		<xs:complexType>
 451 | 			<xs:sequence>
 452 | 				<xs:element ref="description" minOccurs="0" />
 453 | 				<xs:element name="variable" minOccurs="0" maxOccurs="unbounded">
 454 | 					<xs:annotation>
 455 | 						<xs:documentation>When you want to add multiple domains to the Server element, you can use a variable and provide the list of possible values.</xs:documentation>
 456 | 					</xs:annotation>
 457 | 					<xs:complexType>
 458 | 						<xs:sequence>
 459 | 							<xs:element ref="description" minOccurs="0" />
 460 | 						</xs:sequence>
 461 | 						<xs:attribute name="name" type="name-string" use="required">
 462 | 							<xs:annotation>
 463 | 								<xs:documentation>Give a name for the variable.</xs:documentation>
 464 | 							</xs:annotation>
 465 | 						</xs:attribute>
 466 | 						<xs:attribute name="values" type="xs:string" use="required">
 467 | 							<xs:annotation>
 468 | 								<xs:documentation>Specify the possible values of variable.</xs:documentation>
 469 | 							</xs:annotation>
 470 | 						</xs:attribute>
 471 | 					</xs:complexType>
 472 | 				</xs:element>
 473 | 				<xs:element name="environment" minOccurs="0" maxOccurs="unbounded">
 474 | 					<xs:annotation>
 475 | 						<xs:documentation>Mention the <b>environment details of the server</b> in this element.</xs:documentation>
 476 | 					</xs:annotation>
 477 | 					<xs:complexType>
 478 | 						<xs:sequence>
 479 | 							<xs:element ref="description" minOccurs="0" />
 480 | 						</xs:sequence>
 481 | 						<xs:attribute name="type" use="required">
 482 | 							<xs:annotation>
 483 | 								<xs:documentation>Mention the environment using which the user can access the API.</xs:documentation>
 484 | 							</xs:annotation>
 485 | 							<xs:simpleType>
 486 | 								<xs:restriction base="xs:string">
 487 | 									<xs:enumeration value="development" />
 488 | 									<xs:enumeration value="sandbox" />
 489 | 									<xs:enumeration value="production" />
 490 | 								</xs:restriction>
 491 | 							</xs:simpleType>
 492 | 						</xs:attribute>
 493 | 						<xs:attribute name="location">
 494 | 							<xs:annotation>
 495 | 								<xs:documentation>Mention the location of arguments.</xs:documentation>
 496 | 							</xs:annotation>
 497 | 							<xs:simpleType>
 498 | 								<xs:restriction base="xs:string">
 499 | 									<xs:enumeration value="param" />
 500 | 									<xs:enumeration value="header" />
 501 | 								</xs:restriction>
 502 | 							</xs:simpleType>
 503 | 						</xs:attribute>
 504 | 						<xs:attribute name="name" type="name-string">
 505 | 							<xs:annotation>
 506 | 								<xs:documentation>Specify a name for the header or the param.</xs:documentation>
 507 | 							</xs:annotation>
 508 | 						</xs:attribute>
 509 | 						<xs:attribute name="value" type="xs:string">
 510 | 							<xs:annotation>
 511 | 								<xs:documentation>Specify the value of the header/param.</xs:documentation>
 512 | 							</xs:annotation>
 513 | 						</xs:attribute>
 514 | 					</xs:complexType>
 515 | 				</xs:element>
 516 | 			</xs:sequence>
 517 | 
 518 | 			<xs:attribute name="name" type="name-string" use="required">
 519 | 				<xs:annotation>
 520 | 					<xs:documentation>Specify a name for the server.</xs:documentation>
 521 | 				</xs:annotation>
 522 | 			</xs:attribute>
 523 | 			<xs:attribute name="dc" type="xs:string" use="required">
 524 | 				<xs:annotation>
 525 | 					<xs:documentation>Mention the name of the data centre.</xs:documentation>
 526 | 				</xs:annotation>
 527 | 			</xs:attribute>
 528 | 			<xs:attribute name="url" type="xs:anyURI" use="required">
 529 | 				<xs:annotation>
 530 | 					<xs:documentation>Mention the domain url.</xs:documentation>
 531 | 				</xs:annotation>
 532 | 			</xs:attribute>
 533 | 			<xs:attribute ref="visibility" />
 534 | 		</xs:complexType>
 535 | 		<xs:unique name="unique-environment-type">
 536 | 			<xs:selector xpath="environment"></xs:selector>
 537 | 			<xs:field xpath="@type"></xs:field>
 538 | 		</xs:unique>
 539 | 		<xs:unique name="unique-variable-name">
 540 | 			<xs:selector xpath="variable"></xs:selector>
 541 | 			<xs:field xpath="@name"></xs:field>
 542 | 		</xs:unique>
 543 | 	</xs:element>
 544 | 
 545 | 	<xs:element name="server-ref">
 546 | 		<xs:annotation>
 547 | 			<xs:documentation>Refer tag from local components / other resources / global component.</xs:documentation>
 548 | 		</xs:annotation>
 549 | 		<xs:complexType>
 550 | 			<xs:attribute name="name" type="xs:string" use="required">
 551 | 				<xs:annotation>
 552 | 					<xs:documentation>Provide the name of the tag specifiecd in the components.</xs:documentation>
 553 | 				</xs:annotation>
 554 | 			</xs:attribute>
 555 | 		</xs:complexType>
 556 | 	</xs:element>
 557 | 
 558 | 	<xs:complexType name="contact-details">
 559 | 		<xs:attribute name="name" type="name-string" use="required">
 560 | 			<xs:annotation>
 561 | 				<xs:documentation>Give the name of the organisation or team or contact person which handles the support to add to the help document.</xs:documentation>
 562 | 			</xs:annotation>
 563 | 		</xs:attribute>
 564 | 		<xs:attribute name="email" type="xs:string">
 565 | 			<xs:annotation>
 566 | 				<xs:documentation>Give the e-mail ID of the support team to add to the help document.</xs:documentation>
 567 | 			</xs:annotation>
 568 | 		</xs:attribute>
 569 | 		<xs:attribute name="url" type="xs:anyURI">
 570 | 			<xs:annotation>
 571 | 				<xs:documentation>Give the website links of the organisation to list in the help document.</xs:documentation>
 572 | 			</xs:annotation>
 573 | 		</xs:attribute>
 574 | 		<xs:attribute ref="visibility" />
 575 | 	</xs:complexType>
 576 | 
 577 | 	<xs:element name="contact-details-ref">
 578 | 		<xs:annotation>
 579 | 			<xs:documentation>Refer contact-details from local components / other resources / global component.</xs:documentation>
 580 | 		</xs:annotation>
 581 | 		<xs:complexType>
 582 | 			<xs:attribute name="name" type="xs:string" use="required">
 583 | 				<xs:annotation>
 584 | 					<xs:documentation>Provide the name of the contact-details specifiecd in the components.</xs:documentation>
 585 | 				</xs:annotation>
 586 | 			</xs:attribute>
 587 | 		</xs:complexType>
 588 | 	</xs:element>
 589 | 
 590 | 	<xs:element name="terms-of-service-ref">
 591 | 		<xs:annotation>
 592 | 			<xs:documentation>Refer terms-of-service from local components / other resources / global component.</xs:documentation>
 593 | 		</xs:annotation>
 594 | 		<xs:complexType>
 595 | 			<xs:attribute name="name" type="xs:string" use="required">
 596 | 				<xs:annotation>
 597 | 					<xs:documentation>Provide the name of the terms-of-service specifiecd in the components.</xs:documentation>
 598 | 				</xs:annotation>
 599 | 			</xs:attribute>
 600 | 		</xs:complexType>
 601 | 	</xs:element>
 602 | 
 603 | 	<xs:element name="license-details">
 604 | 		<xs:annotation>
 605 | 			<xs:documentation>Furnish the relevant information regarding the license associated with the API.</xs:documentation>
 606 | 		</xs:annotation>
 607 | 		<xs:complexType>
 608 | 			<xs:attribute name="name" type="name-string" use="required">
 609 | 				<xs:annotation>
 610 | 					<xs:documentation>Mention the name of the license.</xs:documentation>
 611 | 				</xs:annotation>
 612 | 			</xs:attribute>
 613 | 			<xs:attribute name="url" type="xs:anyURI">
 614 | 				<xs:annotation>
 615 | 					<xs:documentation>Mention the url of the license.</xs:documentation>
 616 | 				</xs:annotation>
 617 | 			</xs:attribute>
 618 | 		</xs:complexType>
 619 | 	</xs:element>
 620 | 
 621 | 	<xs:element name="license-details-ref">
 622 | 		<xs:annotation>
 623 | 			<xs:documentation>Refer license-details from local components / other resources / global component.</xs:documentation>
 624 | 		</xs:annotation>
 625 | 		<xs:complexType>
 626 | 			<xs:attribute name="name" type="xs:string" use="required">
 627 | 				<xs:annotation>
 628 | 					<xs:documentation>Provide the name of the license-details specifiecd in the components.</xs:documentation>
 629 | 				</xs:annotation>
 630 | 			</xs:attribute>
 631 | 		</xs:complexType>
 632 | 	</xs:element>
 633 | 
 634 | 	<xs:complexType name="throttling">
 635 | 		<xs:attribute name="threshold" type="xs:positiveInteger" use="required">
 636 | 			<xs:annotation>
 637 | 				<xs:documentation>Give the maximum number of allowed requests for the specified duration.</xs:documentation>
 638 | 			</xs:annotation>
 639 | 		</xs:attribute>
 640 | 		<xs:attribute name="duration" use="required">
 641 | 			<xs:annotation>
 642 | 				<xs:documentation>Give the time period (milliseconds) for which you allow the user to make the maximum number of calls(threshold). Range 1 minute to 29 days.</xs:documentation>
 643 | 			</xs:annotation>
 644 | 			<xs:simpleType>
 645 | 				<xs:restriction base="xs:unsignedLong">
 646 | 					<xs:minInclusive value="60000"/>
 647 |       				<xs:maxInclusive value="2505600000"/>
 648 | 				</xs:restriction>
 649 | 			</xs:simpleType>
 650 | 		</xs:attribute>
 651 | 		<xs:attribute name="lock-period" type="xs:integer">
 652 | 			<xs:annotation>
 653 | 				<xs:documentation>Mention the time period for which the operation should be locked if the user exceeds the threshold within the given duration.</xs:documentation>
 654 | 			</xs:annotation>
 655 | 		</xs:attribute>
 656 | 		<xs:attribute name="type" use="required">
 657 | 			<xs:annotation>
 658 | 				<xs:documentation>It states whether the throttling is applicable in the organization or the IP level. The possible values are global and ip. The 'global' will make the throttling applicable at the organization level. Whereas, 'ip' will make the throttling applicable for each and every IP addresses used to fire API calls.</xs:documentation>
 659 | 			</xs:annotation>
 660 | 			<xs:simpleType>
 661 | 				<xs:restriction base="xs:string">
 662 | 					<xs:enumeration value="global" />
 663 | 					<xs:enumeration value="ip" />
 664 | 				</xs:restriction>
 665 | 			</xs:simpleType>
 666 | 		</xs:attribute>
 667 | 	</xs:complexType>
 668 | 
 669 | 	<xs:element name="throttling-ref">
 670 | 		<xs:annotation>
 671 | 			<xs:documentation>Refer throttling from local components / other resources / global component.</xs:documentation>
 672 | 		</xs:annotation>
 673 | 		<xs:complexType>
 674 | 			<xs:attribute name="name" type="ref-name-string" use="required">
 675 | 				<xs:annotation>
 676 | 					<xs:documentation>Provide the name of the throttling specifiecd in the components.</xs:documentation>
 677 | 				</xs:annotation>
 678 | 			</xs:attribute>
 679 | 		</xs:complexType>
 680 | 	</xs:element>
 681 | 
 682 | 	<xs:element name="token">
 683 | 		<xs:annotation>
 684 | 			<xs:documentation>Mention the <b>details related to token flow</b> for authorizing your API.</xs:documentation>
 685 | 		</xs:annotation>
 686 | 		<xs:complexType>
 687 | 			<xs:sequence>
 688 | 				<xs:element ref="description" minOccurs="0" />
 689 | 				<xs:element name="token-url" type="url">
 690 | 					<xs:annotation>
 691 | 						<xs:documentation>Give the details of URL and possible operations in this element.</xs:documentation>
 692 | 					</xs:annotation>
 693 | 				</xs:element>
 694 | 				<xs:element name="authentication-url" type="url" minOccurs="0">
 695 | 					<xs:annotation>
 696 | 						<xs:documentation>Give the details of URL and possible operations in this element.</xs:documentation>
 697 | 					</xs:annotation>
 698 | 				</xs:element>
 699 | 			</xs:sequence>
 700 | 			<xs:attribute name="name" use="required" type="name-string">
 701 | 				<xs:annotation>
 702 | 					<xs:documentation>Give a name to the token flow here.</xs:documentation>
 703 | 				</xs:annotation>
 704 | 			</xs:attribute>
 705 | 			<xs:attribute ref="visibility" />
 706 | 		</xs:complexType>
 707 | 	</xs:element>
 708 | 
 709 | 	<xs:element name="token-ref">
 710 | 		<xs:annotation>
 711 | 			<xs:documentation>Refer token from local components / other resources / global component.</xs:documentation>
 712 | 		</xs:annotation>
 713 | 		<xs:complexType>
 714 | 			<xs:attribute name="name" type="ref-name-string" use="required">
 715 | 				<xs:annotation>
 716 | 					<xs:documentation>Provide the name of the token specifiecd in the components.</xs:documentation>
 717 | 				</xs:annotation>
 718 | 			</xs:attribute>
 719 | 		</xs:complexType>
 720 | 	</xs:element>
 721 | 
 722 | 	<xs:element name="oauth2">
 723 | 		<xs:annotation>
 724 | 			<xs:documentation>Mention the <b>details related to OAuth2 flow</b> for authorizing your API.</xs:documentation>
 725 | 		</xs:annotation>
 726 | 		<xs:complexType>
 727 | 			<xs:sequence>
 728 | 				<xs:element ref="description" minOccurs="0" />
 729 | 				<xs:element name="authorization-url" type="url">
 730 | 					<xs:annotation>
 731 | 						<xs:documentation>Give the details of URL and possible operations in this element.</xs:documentation>
 732 | 					</xs:annotation>
 733 | 				</xs:element>
 734 | 				<xs:element name="token-url" type="url">
 735 | 					<xs:annotation>
 736 | 						<xs:documentation>Give the details of URL and possible operations in this element.</xs:documentation>
 737 | 					</xs:annotation>
 738 | 				</xs:element>
 739 | 				<xs:element name="refresh-url" type="url">
 740 | 					<xs:annotation>
 741 | 						<xs:documentation>Give the details of URL and possible operations in this element.</xs:documentation>
 742 | 					</xs:annotation>
 743 | 				</xs:element>
 744 | 				<xs:element name="authentication-url" type="url" minOccurs="0">
 745 | 					<xs:annotation>
 746 | 						<xs:documentation>Give the details of URL and possible operations in this element.</xs:documentation>
 747 | 					</xs:annotation>
 748 | 				</xs:element>
 749 | 			</xs:sequence>
 750 | 			<xs:attribute name="name" use="required" type="name-string">
 751 | 				<xs:annotation>
 752 | 					<xs:documentation>You can give a name to the OAuth2 flow here.</xs:documentation>
 753 | 				</xs:annotation>
 754 | 			</xs:attribute>
 755 | 			<xs:attribute ref="visibility" />
 756 | 		</xs:complexType>
 757 | 	</xs:element>
 758 | 
 759 | 	<xs:element name="oauth2-ref">
 760 | 		<xs:annotation>
 761 | 			<xs:documentation>Refer oauth2 from local components / other resources / global component.</xs:documentation>
 762 | 		</xs:annotation>
 763 | 		<xs:complexType>
 764 | 			<xs:attribute name="name" type="ref-name-string" use="required">
 765 | 				<xs:annotation>
 766 | 					<xs:documentation>Provide the name of the oauth2 specifiecd in the components.</xs:documentation>
 767 | 				</xs:annotation>
 768 | 			</xs:attribute>
 769 | 		</xs:complexType>
 770 | 	</xs:element>
 771 | 
 772 | 	<xs:attributeGroup name="structure-attributes">
 773 | 		<xs:attribute name="name" type="name-string">
 774 | 			<xs:annotation>
 775 | 				<xs:documentation>Give a name for the structure. Refer the note below.</xs:documentation>
 776 | 			</xs:annotation>
 777 | 		</xs:attribute>
 778 | 		<xs:attribute ref="visibility" />
 779 | 		<xs:attribute name="discriminator-value" type="xs:string">
 780 | 			<xs:annotation>
 781 | 				<xs:documentation>Give the value of the discriminator mapping for which this structure should be picked.</xs:documentation>
 782 | 			</xs:annotation>
 783 | 		</xs:attribute>
 784 | 		<xs:attribute name="extend" type="ref-name-string">
 785 | 			<xs:annotation>
 786 | 				<xs:documentation>Specify the name of the structure which you are trying to extend.</xs:documentation>
 787 | 			</xs:annotation>
 788 | 		</xs:attribute>
 789 | 		<xs:attribute name="cases" type="xs:string">
 790 | 			<xs:annotation>
 791 | 				<xs:documentation>For Automation, to validate that a particular test case returns a specific structure, we recommend you to add the case name.</xs:documentation>
 792 | 			</xs:annotation>
 793 | 		</xs:attribute>
 794 | 		<xs:attribute name="lookup" type="resource-string">
 795 | 			<xs:annotation>
 796 | 				<xs:documentation></xs:documentation>
 797 | 			</xs:annotation>
 798 | 		</xs:attribute>
 799 | 		<xs:anyAttribute processContents="lax" />
 800 | 	</xs:attributeGroup>
 801 | 
 802 | 	<xs:complexType name="ref-structure">
 803 | 		<xs:complexContent>
 804 | 			<xs:extension base="primary-structure">
 805 | 				<xs:attribute name="ref-name" type="name-string" use="required">
 806 | 					<xs:annotation>
 807 | 						<xs:documentation>Give a unique value to refer the current structure in some other part of the same or different ZSPEC files.</xs:documentation>
 808 | 					</xs:annotation>
 809 | 				</xs:attribute>
 810 | 			</xs:extension>
 811 | 		</xs:complexContent>
 812 | 	</xs:complexType>
 813 | 
 814 | 	<xs:element name="structure" type="primary-structure">
 815 | 		<xs:annotation>
 816 | 			<xs:documentation>Give the structural information of the body of request / response / argument.</xs:documentation>
 817 | 		</xs:annotation>
 818 | 		<xs:unique name="unique-structure-property-name">
 819 | 			<xs:selector xpath="property"></xs:selector>
 820 | 			<xs:field xpath="@name"></xs:field>
 821 | 		</xs:unique>
 822 | 		<xs:unique name="unique-structure-property-name-regex">
 823 | 			<xs:selector xpath="property"></xs:selector>
 824 | 			<xs:field xpath="@name-regex"></xs:field>
 825 | 		</xs:unique>
 826 | 	</xs:element>
 827 | 
 828 | 	<xs:complexType name="primary-structure">
 829 | 		<xs:sequence>
 830 | 			<xs:element ref="deprecate" minOccurs="0" />
 831 | 			<xs:element name="property" type="property" minOccurs="0" maxOccurs="unbounded">
 832 | 				<xs:annotation>
 833 | 					<xs:documentation>Mention the properties of the argument, request and response structures here along with its details.</xs:documentation>
 834 | 				</xs:annotation>
 835 | 			</xs:element>
 836 | 			<xs:element name="extra-property" type="extra-property" minOccurs="0" maxOccurs="unbounded">
 837 | 				<xs:annotation>
 838 | 					<xs:documentation>An extra property behaves the same as a usual property except for the name which has to match the regex pattern provided in the name-regex attribute.</xs:documentation>
 839 | 				</xs:annotation>
 840 | 			</xs:element>
 841 | 		</xs:sequence>
 842 | 		<xs:attributeGroup ref="structure-attributes" />
 843 | 	</xs:complexType>
 844 | 
 845 | 	<xs:element name="structure-ref">
 846 | 		<xs:annotation>
 847 | 			<xs:documentation>Refer structure from local components / other resources / global component.</xs:documentation>
 848 | 		</xs:annotation>
 849 | 		<xs:complexType>
 850 | 			<xs:attribute name="name" type="ref-name-string" use="required">
 851 | 				<xs:annotation>
 852 | 					<xs:documentation>Provide the name of the structure specifiecd in the components.</xs:documentation>
 853 | 				</xs:annotation>
 854 | 			</xs:attribute>
 855 | 		</xs:complexType>
 856 | 	</xs:element>
 857 | 
 858 | 	<xs:element name="discriminator">
 859 | 		<xs:annotation>
 860 | 			<xs:documentation>When you want to pick a structure based on the value of a particular property, give the name of that property and mapping details in this element.</xs:documentation>
 861 | 		</xs:annotation>
 862 | 		<xs:complexType>
 863 | 			<xs:choice minOccurs="0" maxOccurs="unbounded">
 864 | 				<xs:element ref="mapping" />
 865 | 			</xs:choice>
 866 | 			<xs:attribute name="property-name" type="xs:string" use="required">
 867 | 				<xs:annotation>
 868 | 					<xs:documentation>Mention the name of the discriminator property.</xs:documentation>
 869 | 				</xs:annotation>
 870 | 			</xs:attribute>
 871 | 		</xs:complexType>
 872 | 		<xs:unique name="unique-value">
 873 | 			<xs:selector xpath="mapping"></xs:selector>
 874 | 			<xs:field xpath="@value"></xs:field>
 875 | 		</xs:unique>
 876 | 		<xs:unique name="unique-structure-ref-name">
 877 | 			<xs:selector xpath="mapping"></xs:selector>
 878 | 			<xs:field xpath="@structure-ref"></xs:field>
 879 | 		</xs:unique>
 880 | 	</xs:element>
 881 | 
 882 | 	<xs:element name="mapping">
 883 | 		<xs:annotation>
 884 | 			<xs:documentation>To map a structure based on the value of a particular property (that you mention in property-name of discriminator).</xs:documentation>
 885 | 		</xs:annotation>
 886 | 		<xs:complexType>
 887 | 			<xs:attribute name="value" type="xs:string" use="required">
 888 | 				<xs:annotation>
 889 | 					<xs:documentation>Give the value of the discriminator property based on which you want to map the structure.</xs:documentation>
 890 | 				</xs:annotation>
 891 | 			</xs:attribute>
 892 | 			<xs:attribute name="structure-ref" type="ref-name-string" use="required">
 893 | 				<xs:annotation>
 894 | 					<xs:documentation>Ref name of the structure that you want to map.</xs:documentation>
 895 | 				</xs:annotation>
 896 | 			</xs:attribute>
 897 | 		</xs:complexType>
 898 | 	</xs:element>
 899 | 
 900 | 	<xs:element name="structure-group">
 901 | 		<xs:annotation>
 902 | 			<xs:documentation>You can group multiple structures inside a structure group.</xs:documentation>
 903 | 		</xs:annotation>
 904 | 		<xs:complexType>
 905 | 			<xs:sequence>
 906 | 				<xs:choice maxOccurs="unbounded">
 907 | 					<xs:element ref="structure" />
 908 | 					<xs:element ref="structure-ref" />
 909 | 				</xs:choice>
 910 | 				<xs:element ref="discriminator" minOccurs="0" />
 911 | 			</xs:sequence>
 912 | 			<xs:attribute name="name" type="name-string">
 913 | 				<xs:annotation>
 914 | 					<xs:documentation>If you add a name here then it is <b>mandatory</b> to add names to all the child structures.</xs:documentation>
 915 | 				</xs:annotation>
 916 | 			</xs:attribute>
 917 | 			<xs:attribute name="type" use="required">
 918 | 				<xs:annotation>
 919 | 					<xs:documentation>State how do you want to pick the structure for your case. The possible values are <b>one-of, any-of, all-of, array-of</b>.</xs:documentation>
 920 | 				</xs:annotation>
 921 | 				<xs:simpleType>
 922 | 					<xs:restriction base="xs:string">
 923 | 						<xs:enumeration value="any-of" />
 924 | 						<xs:enumeration value="one-of" />
 925 | 						<xs:enumeration value="all-of" />
 926 | 						<xs:enumeration value="array-of" />
 927 | 					</xs:restriction>
 928 | 				</xs:simpleType>
 929 | 			</xs:attribute>
 930 | 			<xs:anyAttribute processContents="lax" />
 931 | 		</xs:complexType>
 932 | 		<xs:unique name="unique-structure-ref">
 933 | 			<xs:selector xpath="structure-ref"></xs:selector>
 934 | 			<xs:field xpath="@name"></xs:field>
 935 | 		</xs:unique>
 936 | 	</xs:element>
 937 | 
 938 | 	<xs:element name="deprecate">
 939 | 		<xs:annotation>
 940 | 			<xs:documentation>Provide the <b>deprecation details</b> (i.e., the outdated or no longer supported information) of the API.</xs:documentation>
 941 | 		</xs:annotation>
 942 | 		<xs:complexType>
 943 | 			<xs:sequence>
 944 | 				<xs:element ref="description" minOccurs="0" />
 945 | 			</xs:sequence>
 946 | 			<xs:attribute name="alternate" type="xs:anyURI">
 947 | 				<xs:annotation>
 948 | 					<xs:documentation>Give the <b>replacement url</b> related to the deprecated API operation. This will be added to the help document.</xs:documentation>
 949 | 				</xs:annotation>
 950 | 			</xs:attribute>
 951 | 			<xs:attribute name="since" type="version-string" use="required">
 952 | 				<xs:annotation>
 953 | 					<xs:documentation>Provide the version number that corresponds to the <b>deprecated version</b>.</xs:documentation>
 954 | 				</xs:annotation>
 955 | 			</xs:attribute>
 956 | 			<xs:attribute name="for-removal" type="xs:boolean" default="false">
 957 | 				<xs:annotation>
 958 | 					<xs:documentation>Indicate whether deprecation will occur in the next immediate version by specifying <b>true</b>. Otherwise, if deprecation is not planned for the next version, please specify <b>false</b>.</xs:documentation>
 959 | 				</xs:annotation>
 960 | 			</xs:attribute>
 961 | 		</xs:complexType>
 962 | 	</xs:element>
 963 | 
 964 | 	<xs:simpleType name="min-max">
 965 | 		<xs:restriction base="xs:string">
 966 | 			<xs:pattern value="\d+|\d+,(-1|\d+)" />
 967 | 		</xs:restriction>
 968 | 	</xs:simpleType>
 969 | 
 970 | 	<xs:simpleType name="visibility">
 971 | 		<xs:restriction base="xs:string">
 972 | 			<xs:enumeration value="internal" />
 973 | 			<xs:enumeration value="private" />
 974 | 			<xs:enumeration value="public" />
 975 | 		</xs:restriction>
 976 | 	</xs:simpleType>
 977 | 
 978 | 	<xs:complexType name="extra-property">
 979 | 		<xs:complexContent>
 980 | 			<xs:extension base="generic-property">
 981 | 				<xs:attribute name="name-regex" type="xs:string">
 982 | 					<xs:annotation>
 983 | 						<xs:documentation>Mention the regex pattern to which the name of the property should match.</xs:documentation>
 984 | 					</xs:annotation>
 985 | 				</xs:attribute>
 986 | 			</xs:extension>
 987 | 		</xs:complexContent>
 988 | 	</xs:complexType>
 989 | 
 990 | 	<xs:complexType name="property">
 991 | 		<xs:complexContent>
 992 | 			<xs:extension base="generic-property">
 993 | 				<xs:attribute name="name" type="any-string">
 994 | 					<xs:annotation>
 995 | 						<xs:documentation>
 996 | 							Mention the name of the property. This name is
 997 | 							<b>mandatory</b>
 998 | 							if you add more than one property to a structure.
 999 | 						</xs:documentation>
1000 | 					</xs:annotation>
1001 | 				</xs:attribute>
1002 | 			</xs:extension>
1003 | 		</xs:complexContent>
1004 | 	</xs:complexType>
1005 | 
1006 | 	<xs:complexType name="simple-property">
1007 | 		<xs:group ref="simple-property-group" />
1008 | 		<xs:attribute name="type" type="property-type">
1009 | 			<xs:annotation>
1010 | 				<xs:documentation>Specify the data type of the property.</xs:documentation>
1011 | 			</xs:annotation>
1012 | 		</xs:attribute>
1013 | 		<xs:attributeGroup ref="simple-property-attributes" />
1014 | 	</xs:complexType>
1015 | 
1016 | 	<xs:complexType name="generic-property">
1017 | 		<xs:choice>
1018 | 			<xs:group ref="simple-property-group" />
1019 | 			<xs:element name="extend-property" type="simple-property" minOccurs="0" maxOccurs="unbounded">
1020 | 				<xs:annotation>
1021 | 					<xs:documentation>The extend-property allows you to override or switch to different attribute values with respect to the parent property attributes.</xs:documentation>
1022 | 				</xs:annotation>
1023 | 			</xs:element>
1024 | 		</xs:choice>
1025 | 		<xs:attribute name="type" type="property-type" use="required">
1026 | 			<xs:annotation>
1027 | 				<xs:documentation>Specify the data type of the property.</xs:documentation>
1028 | 			</xs:annotation>
1029 | 		</xs:attribute>
1030 | 		<xs:attributeGroup ref="simple-property-attributes" />
1031 | 	</xs:complexType>
1032 | 
1033 | 	<xs:simpleType name="property-type">
1034 | 		<xs:restriction base="xs:string">
1035 | 			<xs:enumeration value="object" />
1036 | 
1037 | 			<xs:enumeration value="string" />
1038 | 
1039 | 			<xs:enumeration value="integer" />
1040 | 			<xs:enumeration value="long_string" />
1041 | 			<xs:enumeration value="long" />
1042 | 			<xs:enumeration value="float" />
1043 | 			<xs:enumeration value="double" />
1044 | 			<xs:enumeration value="serial" />
1045 | 
1046 | 			<xs:enumeration value="boolean" />
1047 | 
1048 | 			<xs:enumeration value="date" />
1049 | 			<xs:enumeration value="time" />
1050 | 			<xs:enumeration value="datetime" />
1051 | 			<xs:enumeration value="timezone" />
1052 | 
1053 | 			<xs:enumeration value="collections" />
1054 | 			<xs:enumeration value="array" />
1055 | 			<xs:enumeration value="map" />
1056 | 
1057 | 			<xs:enumeration value="password" />
1058 | 			<xs:enumeration value="byte" />
1059 | 			<xs:enumeration value="binary" />
1060 | 			<xs:enumeration value="file" />
1061 | 		</xs:restriction>
1062 | 	</xs:simpleType>
1063 | 
1064 | 	<xs:group name="simple-property-group">
1065 | 		<xs:sequence>
1066 | 			<xs:element ref="deprecate" minOccurs="0" />
1067 | 			<xs:element ref="description" minOccurs="0" />
1068 | 			<xs:element name="xml-format" minOccurs="0">
1069 | 				<xs:annotation>
1070 | 					<xs:documentation>Mention the changes you want in the xml representation of a property like which is the attribute and which is the child element, prefix to be added and wrapper element details.</xs:documentation>
1071 | 				</xs:annotation>
1072 | 				<xs:complexType>
1073 | 					<xs:attribute name="name" type="any-string">
1074 | 						<xs:annotation>
1075 | 							<xs:documentation>Mention the name you want, when the property gets changes to an xml.</xs:documentation>
1076 | 						</xs:annotation>
1077 | 					</xs:attribute>
1078 | 					<xs:attribute name="namespace" type="xs:anyURI">
1079 | 						<xs:annotation>
1080 | 							<xs:documentation>Mention the namespace required to be added for the xml.</xs:documentation>
1081 | 						</xs:annotation>
1082 | 					</xs:attribute>
1083 | 					<xs:attribute name="prefix" type="name-string">
1084 | 						<xs:annotation>
1085 | 							<xs:documentation>Mention the prefix you want to add to the xml tags.</xs:documentation>
1086 | 						</xs:annotation>
1087 | 					</xs:attribute>
1088 | 					<xs:attribute name="attribute" type="xs:boolean" default="false">
1089 | 						<xs:annotation>
1090 | 							<xs:documentation>Mention true if you want to make the property as an attribute. If this is false then the property will be treated as child element. By default this will be considered as false.</xs:documentation>
1091 | 						</xs:annotation>
1092 | 					</xs:attribute>
1093 | 					<xs:attribute name="wrapped" type="xs:boolean" default="false">
1094 | 						<xs:annotation>
1095 | 							<xs:documentation>Mention if the wrapper element for the xml is required or not. By default this will be considered as false.</xs:documentation>
1096 | 						</xs:annotation>
1097 | 					</xs:attribute>
1098 | 				</xs:complexType>
1099 | 			</xs:element>
1100 | 			<xs:element ref="file-meta" minOccurs="0" />
1101 | 			<xs:choice minOccurs="0">
1102 | 				<xs:element name="ordered-structures">
1103 | 					<xs:annotation>
1104 | 						<xs:documentation>If you want the structures to be present at specific indices, you can specify the structures in the exact order required using this tag.</xs:documentation>
1105 | 					</xs:annotation>
1106 | 					<xs:complexType>
1107 | 						<xs:choice maxOccurs="unbounded">
1108 | 							<xs:element ref="structure" />
1109 | 							<xs:element ref="structure-ref" />
1110 | 						</xs:choice>
1111 | 					</xs:complexType>
1112 | 				</xs:element>
1113 | 			</xs:choice>
1114 | 			<xs:choice minOccurs="0">
1115 | 				<xs:element ref="structure" />
1116 | 				<xs:element ref="structure-ref" />
1117 | 				<xs:element ref="structure-group" />
1118 | 				<xs:element ref="composite-structure-groups" />
1119 | 			</xs:choice>
1120 | 		</xs:sequence>
1121 | 	</xs:group>
1122 | 
1123 | 	<xs:element name="composite-structure-groups">
1124 | 		<xs:annotation>
1125 | 			<xs:documentation>Whenever you want to combine multiple structure groups from the same or other resources and use it for your current resource, mention the structure group details in this element.</xs:documentation>
1126 | 		</xs:annotation>
1127 | 		<xs:complexType>
1128 | 			<xs:sequence>
1129 | 				<xs:element ref="structure-group" maxOccurs="unbounded" />
1130 | 			</xs:sequence>
1131 | 		</xs:complexType>
1132 | 	</xs:element>
1133 | 
1134 | 	<xs:attributeGroup name="simple-property-attributes">
1135 | 		<xs:attribute ref="visibility" />
1136 | 		<xs:attribute name="values" type="xs:string">
1137 | 			<xs:annotation>
1138 | 				<xs:documentation>Give the possible values for the property.</xs:documentation>
1139 | 			</xs:annotation>
1140 | 		</xs:attribute>
1141 | 		<xs:attribute name="example-value" type="xs:string">
1142 | 			<xs:annotation>
1143 | 				<xs:documentation>Specify an example content for the property that must be published in the API help documentation. If an example is already given in the content, then that example will be published in the help document. Otherwise all example-values of different properties will be grouped together and added to the help document.</xs:documentation>
1144 | 			</xs:annotation>
1145 | 		</xs:attribute>
1146 | 		<xs:attribute name="default-value" type="xs:string">
1147 | 			<xs:annotation>
1148 | 				<xs:documentation>Specify a default value for the property.</xs:documentation>
1149 | 			</xs:annotation>
1150 | 		</xs:attribute>
1151 | 		<xs:attribute name="regex" type="xs:string">
1152 | 			<xs:annotation>
1153 | 				<xs:documentation>Mention the regex pattern to which the property value should match.</xs:documentation>
1154 | 			</xs:annotation>
1155 | 		</xs:attribute>
1156 | 		<xs:attribute name="length" type="min-max">
1157 | 			<xs:annotation>
1158 | 				<xs:documentation>Specify the value's minimum and maximum length/size based on the type of the property.</xs:documentation>
1159 | 			</xs:annotation>
1160 | 		</xs:attribute>
1161 | 		<xs:attribute name="path" type="xs:string">
1162 | 			<xs:annotation>
1163 | 				<xs:documentation>Specify the path from which data must be fetched.</xs:documentation>
1164 | 			</xs:annotation>
1165 | 		</xs:attribute>
1166 | 		<xs:attribute name="required-for" type="constraint-scope" default="none">
1167 | 			<xs:annotation>
1168 | 				<xs:documentation>Specify whether the property key has to appear in the desired location. The possible values are <b>none, all, request, response</b>.</xs:documentation>
1169 | 			</xs:annotation>
1170 | 		</xs:attribute>
1171 | 		<xs:attribute name="nullable-for" type="constraint-scope" default="none">
1172 | 			<xs:annotation>
1173 | 				<xs:documentation>Specify whether the property can be null or not in the desired location. The possible values are <b>none, all, request, response</b>.</xs:documentation>
1174 | 			</xs:annotation>
1175 | 		</xs:attribute>
1176 | 		<xs:attribute name="unique-for" type="constraint-scope" default="none">
1177 | 			<xs:annotation>
1178 | 				<xs:documentation>Specify whether the property should be unique or not in the desired location. The possible values are <b>none, all, request, response</b>.</xs:documentation>
1179 | 			</xs:annotation>
1180 | 		</xs:attribute>
1181 | 		<xs:attribute name="emptiable-for" type="constraint-scope" default="none">
1182 | 			<xs:annotation>
1183 | 				<xs:documentation>Specify whether the property can be empty or not in the desired location. The possible values are <b>none, all, request, response</b>.</xs:documentation>
1184 | 			</xs:annotation>
1185 | 		</xs:attribute>
1186 | 		<xs:attribute name="condition-for-all" type="xs:string" />
1187 | 		<xs:attribute name="condition-for-request" type="xs:string">
1188 | 			<xs:annotation>
1189 | 				<xs:documentation>During Automation, while generating the test-cases, if you want to specify a condition based on which the request body should be constructed, you can mention that criteria here.</xs:documentation>
1190 | 			</xs:annotation>
1191 | 		</xs:attribute>
1192 | 		<xs:attribute name="condition-for-response" type="xs:string">
1193 | 			<xs:annotation>
1194 | 				<xs:documentation>During validation of response, when you want the response to match a particular criteria, mention that here.</xs:documentation>
1195 | 			</xs:annotation>
1196 | 		</xs:attribute>
1197 | 		<xs:attribute name="value-condition" type="xs:string">
1198 | 			<xs:annotation>
1199 | 				<xs:documentation>The property value must meet the specified condition.</xs:documentation>
1200 | 			</xs:annotation>
1201 | 		</xs:attribute>
1202 | 		<xs:attribute name="include-for" default="Request[*], Response[*]" type="xs:string">
1203 | 			<xs:annotation>
1204 | 				<xs:documentation>State whether a property should be included or excluded in an operation. The format for this is <b>Request[list of categories(csv)], Response[list of categories(csv)]</b>.</xs:documentation>
1205 | 			</xs:annotation>
1206 | 		</xs:attribute>
1207 | 		<xs:attribute name="range">
1208 | 			<xs:annotation>
1209 | 				<xs:documentation>If you want to specify the range of values for your property, mention that here. For example range="0,99999" for Integer type and range="A-Z" for string.</xs:documentation>
1210 | 			</xs:annotation>
1211 | 			<xs:simpleType>
1212 | 				<xs:restriction base="xs:string">
1213 | 					<xs:pattern value="-?\d+,\d+" />
1214 | 				</xs:restriction>
1215 | 			</xs:simpleType>
1216 | 		</xs:attribute>
1217 | 		<xs:attribute name="format" type="xs:string">
1218 | 			<xs:annotation>
1219 | 				<xs:documentation>For <b>Date</b> and <b>Date Time</b> properties, you can mention the required format in this attribute. The default value is "yyyy-MM-ddTHH:mm:ss+/-hh:mm".</xs:documentation>
1220 | 			</xs:annotation>
1221 | 		</xs:attribute>
1222 | 		<xs:attribute name="decimal-place" type="xs:integer">
1223 | 			<xs:annotation>
1224 | 				<xs:documentation>Specify the number of decimal places allowed. This is applicable when the property is of type double. If decimal-place="2" , will allow 2 digits after the decimal point.</xs:documentation>
1225 | 			</xs:annotation>
1226 | 		</xs:attribute>
1227 | 		<xs:attribute name="extra-value" default="deny">
1228 | 			<xs:annotation>
1229 | 				<xs:documentation>You can specify how the property should behave when there is a new valid value which is not part of the possible values list.</xs:documentation>
1230 | 			</xs:annotation>
1231 | 			<xs:simpleType>
1232 | 				<xs:restriction base="xs:string">
1233 | 					<xs:enumeration value="allow" />
1234 | 					<xs:enumeration value="deny" />
1235 | 					<xs:enumeration value="map-default" />
1236 | 				</xs:restriction>
1237 | 			</xs:simpleType>
1238 | 		</xs:attribute>
1239 | 		<xs:attribute name="invalid-value" default="deny">
1240 | 			<xs:annotation>
1241 | 				<xs:documentation>You can specify how the property should behave when there is an invalid value (a value that does not satisfy the criteria attributes of property).</xs:documentation>
1242 | 			</xs:annotation>
1243 | 			<xs:simpleType>
1244 | 				<xs:restriction base="xs:string">
1245 | 					<xs:enumeration value="deny" />
1246 | 					<xs:enumeration value="map-default" />
1247 | 				</xs:restriction>
1248 | 			</xs:simpleType>
1249 | 		</xs:attribute>
1250 | 		<xs:anyAttribute processContents="lax" />
1251 | 	</xs:attributeGroup>
1252 | 
1253 | 	<xs:simpleType name="constraint-scope">
1254 | 		<xs:restriction base="xs:string">
1255 | 			<xs:enumeration value="none" />
1256 | 			<xs:enumeration value="all" />
1257 | 			<xs:enumeration value="request" />
1258 | 			<xs:enumeration value="response" />
1259 | 		</xs:restriction>
1260 | 	</xs:simpleType>
1261 | 
1262 | 	<xs:element name="error">
1263 | 		<xs:annotation>
1264 | 			<xs:documentation>Provide the criteria utilized to determine whether a response should be classified as a success or an error. This is for automation.</xs:documentation>
1265 | 		</xs:annotation>
1266 | 		<xs:complexType>
1267 | 			<xs:attribute name="condition" type="xs:string" use="required">
1268 | 				<xs:annotation>
1269 | 					<xs:documentation>Mention the condition to decide whether the response is success or an error.</xs:documentation>
1270 | 				</xs:annotation>
1271 | 			</xs:attribute>
1272 | 		</xs:complexType>
1273 | 	</xs:element>
1274 | 
1275 | 	<xs:element name="content" type="content">
1276 | 		<xs:annotation>
1277 | 			<xs:documentation>Give details about the content of response/request-body/argument.</xs:documentation>
1278 | 		</xs:annotation>
1279 | 	</xs:element>
1280 | 
1281 | 	<xs:complexType name="content">
1282 | 		<xs:sequence>
1283 | 			<xs:element name="encode">
1284 | 				<xs:annotation>
1285 | 					<xs:documentation>Mention the content type.</xs:documentation>
1286 | 				</xs:annotation>
1287 | 				<xs:complexType>
1288 | 					<xs:attribute name="type" use="required" type="any-string">
1289 | 						<xs:annotation>
1290 | 							<xs:documentation>Specify the type of content. For example - application/json, application/xml, text/plain, application/zip.</xs:documentation>
1291 | 						</xs:annotation>
1292 | 					</xs:attribute>
1293 | 				</xs:complexType>
1294 | 			</xs:element>
1295 | 			<xs:element ref="error" minOccurs="0" />
1296 | 			<xs:element ref="path-config" minOccurs="0" />
1297 | 			<xs:choice>
1298 | 				<xs:element ref="structure" />
1299 | 				<xs:element ref="structure-ref" />
1300 | 				<xs:element name="stream">
1301 | 					<xs:annotation>
1302 | 						<xs:documentation>Whenever the request or the response has a file as bytes in raw form, you can give details about the file using this tag.</xs:documentation>
1303 | 					</xs:annotation>
1304 | 					<xs:complexType>
1305 | 						<xs:attribute name="size" type="min-max">
1306 | 							<xs:annotation>
1307 | 								<xs:documentation>Specify the maximum size of the stream in bytes ( size=100") or you can mention the minimum and maximum possible size of the stream separated by comma (size="0,100")</xs:documentation>
1308 | 							</xs:annotation>
1309 | 						</xs:attribute>
1310 | 					</xs:complexType>
1311 | 				</xs:element>
1312 | 				<xs:element ref="structure-group" />
1313 | 				<xs:element ref="composite-structure-groups" />
1314 | 			</xs:choice>
1315 | 			<xs:choice minOccurs="0" maxOccurs="unbounded">
1316 | 				<xs:element name="example">
1317 | 					<xs:annotation>
1318 | 						<xs:documentation>Give example contents for the request/response body in this element. This will be added to the <b>help documentation</b>.</xs:documentation>
1319 | 					</xs:annotation>
1320 | 					<xs:complexType>
1321 | 						<xs:complexContent>
1322 | 							<xs:extension base="example">
1323 | 								<xs:attribute name="name" type="name-string">
1324 | 									<xs:annotation>
1325 | 										<xs:documentation>Give a name for the sample request/response of the API.</xs:documentation>
1326 | 									</xs:annotation>
1327 | 								</xs:attribute>
1328 | 							</xs:extension>
1329 | 						</xs:complexContent>
1330 | 					</xs:complexType>
1331 | 				</xs:element>
1332 | 				<xs:element ref="example-ref" />
1333 | 			</xs:choice>
1334 | 		</xs:sequence>
1335 | 		<xs:attribute ref="visibility" />
1336 | 	</xs:complexType>
1337 | 
1338 | 	<xs:element name="file-meta">
1339 | 		<xs:annotation>
1340 | 			<xs:documentation>Mention the details of the files which are part of the request or reponse of an API.</xs:documentation>
1341 | 		</xs:annotation>
1342 | 		<xs:complexType>
1343 | 			<xs:sequence>
1344 | 				<xs:element name="extension" maxOccurs="unbounded">
1345 | 					<xs:annotation>
1346 | 						<xs:documentation>Mention the details of the extension of the file that the user uploads.</xs:documentation>
1347 | 					</xs:annotation>
1348 | 					<xs:complexType>
1349 | 						<xs:attribute name="name" type="name-string" use="required">
1350 | 							<xs:annotation>
1351 | 								<xs:documentation>You can mention the file extension here. For example txt, csv.</xs:documentation>
1352 | 							</xs:annotation>
1353 | 						</xs:attribute>
1354 | 						<xs:attribute name="size" type="min-max">
1355 | 							<xs:annotation>
1356 | 								<xs:documentation>Mention the size of the file in bytes. If you mention a single value it will be considered as maximum size. You can also mention the minimum and maximum size by sperating the values with a comma i.e., <b>lenghth - 10,50</b>.</xs:documentation>
1357 | 							</xs:annotation>
1358 | 						</xs:attribute>
1359 | 						<xs:attribute name="length" type="min-max">
1360 | 							<xs:annotation>
1361 | 								<xs:documentation>Here you can mention the number of files that can be uploaded. If you mention a single value it will be considered as maximum number of files that can be uploaded. You can also mention the minimum and maximum count of files that can be uploaded by sperating the values with a comma.</xs:documentation>
1362 | 							</xs:annotation>
1363 | 						</xs:attribute>
1364 | 					</xs:complexType>
1365 | 				</xs:element>
1366 | 				<xs:element name="file-name">
1367 | 					<xs:annotation>
1368 | 						<xs:documentation>Mention the validations you want for the file name.</xs:documentation>
1369 | 					</xs:annotation>
1370 | 					<xs:complexType>
1371 | 						<xs:attribute name="regex" type="xs:string" use="required">
1372 | 							<xs:annotation>
1373 | 								<xs:documentation>Mention the regex pattern of the file name here.</xs:documentation>
1374 | 							</xs:annotation>
1375 | 						</xs:attribute>
1376 | 						<xs:attribute name="length" type="min-max">
1377 | 							<xs:annotation>
1378 | 								<xs:documentation>You can specify the minimum and maximum possible length of the file name or you can just mention the maximum possible file name length.</xs:documentation>
1379 | 							</xs:annotation>
1380 | 						</xs:attribute>
1381 | 					</xs:complexType>
1382 | 				</xs:element>
1383 | 			</xs:sequence>
1384 | 			<xs:attribute name="disallowed-extensions" type="any-string">
1385 | 				<xs:annotation>
1386 | 					<xs:documentation>Mention the file extensions that you don't want to allow.</xs:documentation>
1387 | 				</xs:annotation>
1388 | 			</xs:attribute>
1389 | 			<xs:attribute name="content-types" type="xs:string">
1390 | 				<xs:annotation>
1391 | 					<xs:documentation>You can mention the possible content types of the file here.</xs:documentation>
1392 | 				</xs:annotation>
1393 | 			</xs:attribute>
1394 | 			<xs:attribute name="size" type="min-max">
1395 | 				<xs:annotation>
1396 | 					<xs:documentation>Specify the maximum size of the file in bytes ( size="100") or you can mention the minimum and maximum possible size of the file separated by comma (size="0,100").</xs:documentation>
1397 | 				</xs:annotation>
1398 | 			</xs:attribute>
1399 | 			<xs:attribute name="overall-size" type="min-max">
1400 | 				<xs:annotation>
1401 | 					<xs:documentation></xs:documentation>
1402 | 				</xs:annotation>
1403 | 			</xs:attribute>
1404 | 			<xs:attribute name="import-url" type="xs:boolean">
1405 | 				<xs:annotation>
1406 | 					<xs:documentation>You should denote true whenever the file should be read using url. You can mention this only for requests.</xs:documentation>
1407 | 				</xs:annotation>
1408 | 			</xs:attribute>
1409 | 			<xs:attribute name="continue-on-error" type="xs:boolean">
1410 | 				<xs:annotation>
1411 | 					<xs:documentation>When there are a number of files and any one of the files is not as per the expectations configured, mention true to continue validation for other files, otherwise mention as false.</xs:documentation>
1412 | 				</xs:annotation>
1413 | 			</xs:attribute>
1414 | 		</xs:complexType>
1415 | 	</xs:element>
1416 | 
1417 | 	<xs:element name="content-ref">
1418 | 		<xs:annotation>
1419 | 			<xs:documentation>Refer content from local components / other resources / global component.</xs:documentation>
1420 | 		</xs:annotation>
1421 | 		<xs:complexType>
1422 | 			<xs:attribute name="name" type="ref-name-string" use="required">
1423 | 				<xs:annotation>
1424 | 					<xs:documentation>Provide the name of the content specifiecd in the components.</xs:documentation>
1425 | 				</xs:annotation>
1426 | 			</xs:attribute>
1427 | 		</xs:complexType>
1428 | 	</xs:element>
1429 | 
1430 | 	<xs:complexType name="example">
1431 | 		<xs:sequence>
1432 | 			<xs:element ref="description" minOccurs="0" />
1433 | 			<xs:element name="value" type="xs:string">
1434 | 				<xs:annotation>
1435 | 					<xs:documentation>Give the actual example of request or response in this element.</xs:documentation>
1436 | 				</xs:annotation>
1437 | 			</xs:element>
1438 | 		</xs:sequence>
1439 | 	</xs:complexType>
1440 | 
1441 | 	<xs:element name="example-ref">
1442 | 		<xs:annotation>
1443 | 			<xs:documentation>Refer example from local components / other resources / global component.</xs:documentation>
1444 | 		</xs:annotation>
1445 | 		<xs:complexType>
1446 | 			<xs:attribute name="name" type="ref-name-string" use="required">
1447 | 				<xs:annotation>
1448 | 					<xs:documentation>Provide the name of the example specifiecd in the components.</xs:documentation>
1449 | 				</xs:annotation>
1450 | 			</xs:attribute>
1451 | 		</xs:complexType>
1452 | 	</xs:element>
1453 | 
1454 | 	<xs:element name="argument">
1455 | 		<xs:annotation>
1456 | 			<xs:documentation>Give the details of parameter, header and variables of the resource in this element.</xs:documentation>
1457 | 		</xs:annotation>
1458 | 		<xs:complexType>
1459 | 			<xs:sequence>
1460 | 				<xs:element ref="deprecate" minOccurs="0" />
1461 | 				<xs:element ref="description" minOccurs="0" />
1462 | 				<xs:choice maxOccurs="unbounded">
1463 | 					<xs:element ref="content" />
1464 | 					<xs:element ref="content-ref" />
1465 | 				</xs:choice>
1466 | 			</xs:sequence>
1467 | 			<xs:attribute ref="visibility" />
1468 | 			<xs:attribute name="required" type="xs:boolean" default="false">
1469 | 				<xs:annotation>
1470 | 					<xs:documentation>Specify the requirement status of an argument in your API, indicating whether it is mandatory or not.</xs:documentation>
1471 | 				</xs:annotation>
1472 | 			</xs:attribute>
1473 | 			<xs:attribute name="name" type="name-string" use="required">
1474 | 				<xs:annotation>
1475 | 					<xs:documentation>Give a name for the argument.</xs:documentation>
1476 | 				</xs:annotation>
1477 | 			</xs:attribute>
1478 | 			<xs:attribute name="length" type="min-max">
1479 | 				<xs:annotation>
1480 | 					<xs:documentation>Specify the maximum number of values for the argument. You can also specify the minimum and maximum number of values separated by a comma.</xs:documentation>
1481 | 				</xs:annotation>
1482 | 			</xs:attribute>
1483 | 			<xs:attribute name="location" use="required">
1484 | 				<xs:annotation>
1485 | 					<xs:documentation>Specify the location of the argument for your API.</xs:documentation>
1486 | 				</xs:annotation>
1487 | 				<xs:simpleType>
1488 | 					<xs:restriction base="xs:string">
1489 | 						<xs:enumeration value="param" />
1490 | 						<xs:enumeration value="header" />
1491 | 						<xs:enumeration value="variable" />
1492 | 					</xs:restriction>
1493 | 				</xs:simpleType>
1494 | 			</xs:attribute>
1495 | 			<xs:attribute name="delimiter" type="xs:string">
1496 | 				<xs:annotation>
1497 | 					<xs:documentation>Specify the delimiter for multiple values in your API.</xs:documentation>
1498 | 				</xs:annotation>
1499 | 			</xs:attribute>
1500 | 			<xs:attribute name="style">
1501 | 				<xs:annotation>
1502 | 					<xs:documentation>Specify which approach ZEST should use to separate the list of arguments. It can be either standrard or using delimiters.</xs:documentation>
1503 | 				</xs:annotation>
1504 | 				<xs:simpleType>
1505 | 					<xs:restriction base="xs:string">
1506 | 						<xs:enumeration value="delimiter" />
1507 | 						<xs:enumeration value="standard" />
1508 | 					</xs:restriction>
1509 | 				</xs:simpleType>
1510 | 			</xs:attribute>
1511 | 			<xs:attribute name="condition" type="xs:string">
1512 | 				<xs:annotation>
1513 | 					<xs:documentation>Specify the condition which needs to be true in order to accept the arguments.</xs:documentation>
1514 | 				</xs:annotation>
1515 | 			</xs:attribute>
1516 | 			<xs:attribute name="concurrent" type="name-string">
1517 | 				<xs:annotation>
1518 | 					<xs:documentation>Give the name of argument which you want to allow simultaneously.</xs:documentation>
1519 | 				</xs:annotation>
1520 | 			</xs:attribute>
1521 | 			<xs:attribute name="non-concurrent" type="name-string">
1522 | 				<xs:annotation>
1523 | 					<xs:documentation>Give the name of the argument that should not be present simultaneously.</xs:documentation>
1524 | 				</xs:annotation>
1525 | 			</xs:attribute>
1526 | 			<xs:anyAttribute processContents="lax" />
1527 | 		</xs:complexType>
1528 | 	</xs:element>
1529 | 
1530 | 	<xs:element name="argument-ref">
1531 | 		<xs:annotation>
1532 | 			<xs:documentation>Refer argument from local components / other resources / global component.</xs:documentation>
1533 | 		</xs:annotation>
1534 | 		<xs:complexType>
1535 | 			<xs:attribute name="name" type="ref-name-string" use="required">
1536 | 				<xs:annotation>
1537 | 					<xs:documentation>Provide the name of the argument specifiecd in the components.</xs:documentation>
1538 | 				</xs:annotation>
1539 | 			</xs:attribute>
1540 | 		</xs:complexType>
1541 | 	</xs:element>
1542 | 
1543 | 	<xs:complexType name="request-body">
1544 | 		<xs:sequence>
1545 | 			<xs:element ref="description" minOccurs="0" />
1546 | 			<xs:choice maxOccurs="unbounded">
1547 | 				<xs:element ref="content" />
1548 | 				<xs:element ref="content-ref" />
1549 | 			</xs:choice>
1550 | 		</xs:sequence>
1551 | 		<xs:attribute name="wrapped" type="xs:boolean" />
1552 | 	</xs:complexType>
1553 | 
1554 | 	<xs:element name="request-body-ref">
1555 | 		<xs:annotation>
1556 | 			<xs:documentation>Refer request-body from local components / other resources / global component.</xs:documentation>
1557 | 		</xs:annotation>
1558 | 		<xs:complexType>
1559 | 			<xs:attribute name="name" type="ref-name-string" use="required">
1560 | 				<xs:annotation>
1561 | 					<xs:documentation>Provide the name of the request-body specifiecd in the components.</xs:documentation>
1562 | 				</xs:annotation>
1563 | 			</xs:attribute>
1564 | 		</xs:complexType>
1565 | 	</xs:element>
1566 | 
1567 | 	<xs:complexType name="response">
1568 | 		<xs:sequence>
1569 | 			<xs:element ref="description" minOccurs="0" />
1570 | 			<xs:choice minOccurs="0" maxOccurs="unbounded">
1571 | 				<xs:element ref="content" />
1572 | 				<xs:element ref="content-ref" />
1573 | 			</xs:choice>
1574 | 			<xs:choice minOccurs="0" maxOccurs="unbounded">
1575 | 				<xs:element ref="argument" />
1576 | 				<xs:element ref="argument-ref" />
1577 | 			</xs:choice>
1578 | 		</xs:sequence>
1579 | 		<xs:attribute ref="visibility" />
1580 | 		<xs:attribute name="status" use="required">
1581 | 			<xs:annotation>
1582 | 				<xs:documentation>Defines the status codes of the response. It'll accept only the valid status codes. Use this attribute to specify the status codes of your API response.</xs:documentation>
1583 | 			</xs:annotation>
1584 | 			<xs:simpleType>
1585 | 				<xs:restriction base="xs:integer">
1586 | 					<xs:enumeration value="100" />
1587 | 					<xs:enumeration value="101" />
1588 | 					<xs:enumeration value="102" />
1589 | 					<xs:enumeration value="194" />
1590 | 					<xs:enumeration value="195" />
1591 | 					<xs:enumeration value="199" />
1592 | 					<xs:enumeration value="200" />
1593 | 					<xs:enumeration value="201" />
1594 | 					<xs:enumeration value="202" />
1595 | 					<xs:enumeration value="203" />
1596 | 					<xs:enumeration value="204" />
1597 | 					<xs:enumeration value="205" />
1598 | 					<xs:enumeration value="206" />
1599 | 					<xs:enumeration value="207" />
1600 | 					<xs:enumeration value="208" />
1601 | 					<xs:enumeration value="226" />
1602 | 					<xs:enumeration value="232" />
1603 | 					<xs:enumeration value="300" />
1604 | 					<xs:enumeration value="301" />
1605 | 					<xs:enumeration value="302" />
1606 | 					<xs:enumeration value="303" />
1607 | 					<xs:enumeration value="304" />
1608 | 					<xs:enumeration value="305" />
1609 | 					<xs:enumeration value="306" />
1610 | 					<xs:enumeration value="307" />
1611 | 					<xs:enumeration value="308" />
1612 | 					<xs:enumeration value="400" />
1613 | 					<xs:enumeration value="401" />
1614 | 					<xs:enumeration value="402" />
1615 | 					<xs:enumeration value="403" />
1616 | 					<xs:enumeration value="404" />
1617 | 					<xs:enumeration value="405" />
1618 | 					<xs:enumeration value="406" />
1619 | 					<xs:enumeration value="407" />
1620 | 					<xs:enumeration value="408" />
1621 | 					<xs:enumeration value="409" />
1622 | 					<xs:enumeration value="410" />
1623 | 					<xs:enumeration value="411" />
1624 | 					<xs:enumeration value="412" />
1625 | 					<xs:enumeration value="413" />
1626 | 					<xs:enumeration value="414" />
1627 | 					<xs:enumeration value="415" />
1628 | 					<xs:enumeration value="416" />
1629 | 					<xs:enumeration value="417" />
1630 | 					<xs:enumeration value="418" />
1631 | 					<xs:enumeration value="420" />
1632 | 					<xs:enumeration value="422" />
1633 | 					<xs:enumeration value="423" />
1634 | 					<xs:enumeration value="424" />
1635 | 					<xs:enumeration value="425" />
1636 | 					<xs:enumeration value="426" />
1637 | 					<xs:enumeration value="428" />
1638 | 					<xs:enumeration value="429" />
1639 | 					<xs:enumeration value="431" />
1640 | 					<xs:enumeration value="443" />
1641 | 					<xs:enumeration value="444" />
1642 | 					<xs:enumeration value="449" />
1643 | 					<xs:enumeration value="450" />
1644 | 					<xs:enumeration value="451" />
1645 | 					<xs:enumeration value="499" />
1646 | 					<xs:enumeration value="500" />
1647 | 					<xs:enumeration value="501" />
1648 | 					<xs:enumeration value="502" />
1649 | 					<xs:enumeration value="503" />
1650 | 					<xs:enumeration value="504" />
1651 | 					<xs:enumeration value="505" />
1652 | 					<xs:enumeration value="506" />
1653 | 					<xs:enumeration value="507" />
1654 | 					<xs:enumeration value="508" />
1655 | 					<xs:enumeration value="509" />
1656 | 					<xs:enumeration value="510" />
1657 | 					<xs:enumeration value="511" />
1658 | 					<xs:enumeration value="598" />
1659 | 					<xs:enumeration value="599" />
1660 | 				</xs:restriction>
1661 | 			</xs:simpleType>
1662 | 		</xs:attribute>
1663 | 		<xs:attribute name="unexpected-error" type="xs:boolean" default="false">
1664 | 			<xs:annotation>
1665 | 				<xs:documentation>Specify this attribute when you are writing the response element for unhandled errors i.e., internal server error.</xs:documentation>
1666 | 			</xs:annotation>
1667 | 		</xs:attribute>
1668 | 	</xs:complexType>
1669 | 
1670 | 	<xs:element name="response-ref">
1671 | 		<xs:annotation>
1672 | 			<xs:documentation>Refer response from local components / other resources / global component.</xs:documentation>
1673 | 		</xs:annotation>
1674 | 		<xs:complexType>
1675 | 			<xs:attribute name="name" type="ref-name-string" use="required">
1676 | 				<xs:annotation>
1677 | 					<xs:documentation>Provide the name of the response specifiecd in the components.</xs:documentation>
1678 | 				</xs:annotation>
1679 | 			</xs:attribute>
1680 | 		</xs:complexType>
1681 | 	</xs:element>
1682 | 
1683 | 	<xs:element name="authentication">
1684 | 		<xs:annotation>
1685 | 			<xs:documentation>Give details related to the authentication of an operation or resource.</xs:documentation>
1686 | 		</xs:annotation>
1687 | 		<xs:complexType>
1688 | 			<xs:attribute name="type" use="required">
1689 | 				<xs:annotation>
1690 | 					<xs:documentation>Give the type of the authentication.</xs:documentation>
1691 | 				</xs:annotation>
1692 | 				<xs:simpleType>
1693 | 					<xs:restriction base="xs:string">
1694 | 						<xs:enumeration value="oauth2" />
1695 | 						<xs:enumeration value="token" />
1696 | 					</xs:restriction>
1697 | 				</xs:simpleType>
1698 | 			</xs:attribute>
1699 | 			<xs:attribute name="scopes" type="xs:string">
1700 | 				<xs:annotation>
1701 | 					<xs:documentation>Mention the scope for the API.</xs:documentation>
1702 | 				</xs:annotation>
1703 | 			</xs:attribute>
1704 | 			<xs:attribute name="name" type="name-string" use="required">
1705 | 				<xs:annotation>
1706 | 					<xs:documentation>Give a name for the authentication key.</xs:documentation>
1707 | 				</xs:annotation>
1708 | 			</xs:attribute>
1709 | 			<xs:attribute name="location" use="required">
1710 | 				<xs:annotation>
1711 | 					<xs:documentation>Mention the location where the authentication key must be kept.</xs:documentation>
1712 | 				</xs:annotation>
1713 | 				<xs:simpleType>
1714 | 					<xs:restriction base="xs:string">
1715 | 						<xs:enumeration value="param" />
1716 | 						<xs:enumeration value="header" />
1717 | 					</xs:restriction>
1718 | 				</xs:simpleType>
1719 | 			</xs:attribute>
1720 | 			<xs:attribute name="schema" type="ref-name-string" use="required">
1721 | 				<xs:annotation>
1722 | 					<xs:documentation>Mention the name of the oauth or the token used in the authentication schema.</xs:documentation>
1723 | 				</xs:annotation>
1724 | 			</xs:attribute>
1725 | 		</xs:complexType>
1726 | 	</xs:element>
1727 | </xs:schema>
1728 | 


--------------------------------------------------------------------------------