JSON schema

Hybiscus has a JSON schema that is used to validate the JSON report definition sent in requests to the API. This schema describes all the options for every component in the library, and is what powers the validation in both the API, as well as in the Cloud Editor.

This schema is also publicly available for anyone to use can be accessed from here.

To ensure validation is available in the Cloud Editor when working with your own JSON, ensure the following key ($schema) is present at the top of your JSON:

{
  "$schema": "https://hybiscuscdn.blob.core.windows.net/public/Report.schema.json",
  "type": "Report",
  ...
}

The presence or exclusion of this extra key in your JSON report definition will have no effect, as the API by default will always validate your requests using this schema.

You can also use this approach inside your own IDE, such as VS Code, to get IntelliSense and validation as you write your JSON.