Schema Files

Validate your service commissioning files and Helm chart values against the JSON Schema of the Connectware version or chart version you run.

Every Connectware version and every public Helm chart version comes with a JSON Schema. Download the one that matches the version you run.

Schema Versions

Every schema URL takes either latest or a version number. Use latest to always get the current Connectware version or chart version. Use a version number to pin the schema, for example in a CI pipeline that has to keep validating against the version you run.

Schemas are available from these versions onward:

Schema	Available from
Service commissioning file	Connectware 2.0.0
connectware chart	Chart version 3.3.1
connectware-agent chart	Chart version 3.3.1
connectware-toolkit chart	Chart version 1.1.0

Service Commissioning File Schema

Schema	URL
Latest Connectware version	https://download.cybus.io/latest/schemas/scf.schema.json
Specific Connectware version	https://download.cybus.io/${CONNECTWARE_VERSION}/schemas/scf.schema.json

Replace ${CONNECTWARE_VERSION} with the Connectware version you are targeting. For Connectware 2.6.1, the URL is https://download.cybus.io/2.6.1/schemas/scf.schema.json.

The schema is a single file that follows JSON Schema draft-07 and covers a complete service commissioning file, including every resource type and every protocol shipped with that version. Any draft-07 validator can consume it, and the service commissioning file skill downloads it to check the files it generates.

Validate a resolved service commissioning file, meaning one in which you have replaced the !ref, !sub, and !merge tags and all ${...} parameter placeholders with their values. A file that still contains them produces false validation errors.

The schema is stricter than Connectware in one case. It rejects a file that uses a custom connector protocol, although Connectware installs that file. Connectware accepts every file the schema accepts.

Helm Chart Value Schemas

Each public Helm chart version includes a values.schema.json file.

Chart	URL
connectware	https://download.cybus.io/helm/connectware/${CHART_VERSION}/values.schema.json
connectware-agent	https://download.cybus.io/helm/connectware-agent/${CHART_VERSION}/values.schema.json
connectware-toolkit	https://download.cybus.io/helm/connectware-toolkit/${CHART_VERSION}/values.schema.json

Replace ${CHART_VERSION} with the chart version you are targeting, or use latest for the current chart version. For the connectware chart 3.3.1, the URL is https://download.cybus.io/helm/connectware/3.3.1/values.schema.json.

These schemas follow JSON Schema draft 2020-12, and each one covers the values of its own chart. To find the chart version that belongs to your Connectware version, see the compatibility matrix. For the values themselves, see Helm Chart Reference.