The ruleset APIMatic uses to validate WADL documents.
APIMatic validates WADL v2006 and v2009 documents against the ruleset below. These include rules defined by the standard as well as additional checks APIMatic enforces for better output.
A user-friendly title for the target API must be specified in the title attribute of the <doc> section nested directly within the root <application> element. If title information is not found, a default value will be assigned for it automatically during import/transformations in APIMatic.
For a better experience with import/transformation, it is recommended to include all crucial information in your WADL document. One such information is the resource definitions, which must be provided in the <resources> child element nested directly under the root <application> element. The <resources> element must contain at least one resource definition using the <resource> child element.
If the <method> name is set as GET, the <request> element in the method must not contain the inner child <representation> element. This is because use of representation elements is confined to HTTP methods that accept an entity body in the request (e.g. PUT or POST). If this element is found for GET methods, all related information will be ignored automatically during import/transformations in APIMatic.
If multiple responses are disabled via import settings provided in the APIMatic Metadata file, only response definitions belonging to status code ranges 200-208 and 400-599 will be imported. Those outside the supported range will be ignored automatically during import/transformations in APIMatic. Therefore, ensure that the value assigned to the status attribute of a <response> element falls in the same range.
When a <representation> element is defined directly as a child of the root <application> element, it must also specify a non-empty id for it using the id attribute. This id will help uniquely identify the representation in the document and help other components refer it using a URI reference.
The provided WADL document must not contain any syntax/semantic issues and use only valid XML. Each property in the file must have a type or value as defined in the standard.
