Overview
Here is the hierarchical overview of the elements within the ZEST Specification file.
* resource (specification, product, name, pre-loaded)
* components
* example (name)
* description
* value
* structure (ref-name, name, discriminator-name, extend, implement, referenced-structure-name, cases)
* deprecate (alternate, since, for-removal)
* description
* description
* property (name, name-regex, type, values, default-value, example-value, regex, length, path, expression, pick-value, include-for, required-for, nullable-for, unique-for, emtiable-for, condition-for-request, condition-for-response, range, format, decimal-place, extra-value, invalid-value)
* description
* xml-format (name, namespace, prefix, attribute, wrapped)
* file-meta (disallowed-extensions, content-types, size, length, import-url, allow-empty, continue-on-error)
* file-name (regex, length)
* extension (name, size, length)
* ordered-structures
* structure / structure-ref
* structure / structure-ref / structure-group / composite-structure-groups
* extend-property
* extra-property
* content (name)
* encode (type)
* error (condition)
* path-config (data-extraction-path)
* primary (path)
* structure / structure-ref / stream / structure-group / composite-structure-groups
* argument (name, required, length, location, delimiter, style, condition, concurrent, non-concurrent)
* deprecate (alternate, since, for-removal)
* description
* description
* content / content-ref
* request-body (name, wrapped)
* description
* content / content-ref
* response (name, status, availability)
* description
* content / content-ref
* argument / argument-ref
* server (name, dc, url)
* description
* variable (name, values)
* description
* environment (type, location, name, value)
* contact-details (name, email, url)
* license-details (name, url)
* token (name)
* description
* token-url
* authentication-url
* oauth2 (name)
* description
* authorization-url
* token-url
* refresh-url
* authentication-url
* throttling (name, threshold, duration, lock-period)
* info (title, version, limit)
* description
* terms-of-service
* contact-details / contact-details-ref
* license-details / license-details-ref
* server or server-ref
* resource-config (primary-type, primary-structure)
* path-config (data-extraction-path)
* primary (path)
* url (path)
* description
* operation (method, name, category, delay, validation-delay, visibility, primary-fetch, sortable)
* deprecate
* throttling / throttling-ref
* description
* external-document (url)
* description
* tag (name)
* description
* error (condition)
* argument / argument-ref
* request-body / request-body-ref
* response / response-ref (name check in xsd)
* authentication (name, type, scopes, location, scheme)
* authentication-schema
* flow
* (token / token-ref) / (oauth2 / oauth2-ref)
* dependency (resources)
Last Updated 2025-05-30 16:54:59 +0530 +0530
Yes
No
Send your feedback to us
Skip
Submit