Schema

The dataset contents are specified by a JSON schema file stored in the echoSMs repository. The schema specifies the required attributes, their structure, valid values, etc.

• View the raw JSON schema file. This is the authoritative source of the schema.
• Browse an interactive version of the schema.
• View an example datastore file (in TOML format and JSON format).

Validation

Datastore dataset files can be validated against the schema with:

• the validate-toml command line script that is installed when echoSMs is installed,
• online validators (e.g., jsonschema, JSON Schema Validator, JSONSchema.dev, or JSON Validator),
• your own code using a JSON schema validation library (e.g., jsonschema-rs for Python and jsonvalidate for R).

It is not necessary to validate your data before submitting it to the datastore, but it will help the uploading happen faster (a validation is done during the uploading process and any dataset format problems will be identified then).

Note

The JSON schema validation libraries expect either a Python data structure or a JSON file - none work directly with TOML files. The validate-toml script has an option to convert a TOML dataset into a JSON file (use the -j option) or use a TOML-reading library to read into memory and then validate or write out as JSON.