API validators
Since v4.107.0, an API validator is part of the toolset. It shows to what extent the current API v2 output conforms to the specifications and additional requirements.
One more validator checks API v3. It runs the same checks, with its own settings and history, and is open to everyone to view, like the API v2 validator. It has no trigger settings of its own: it runs whenever the API v2 validator is triggered automatically (after a new release, and on publishing or withdrawing an Item, when those are switched on).
Types of checks
The checks are categorised into three domains:
- API Catalogue / XSD specifications compliance
- Data model compliance
- Other
For each check a fail / warn / ignore criterion is set.
Automatic execution
Anyone can view the results of the API v2 and v3 validators. The tools are managed by Workflow managers, who can select when the API v2 validator is run. It can be set to run, for example:
- On the publication or withdrawal of a QC Item.
- After a new release of qc.ebu.io.
The settings page shows which of these are currently switched on.
Workflow managers can also run the tools manually and edit the settings, descriptions, enable/disable checks, etc.