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 authorative source of the schema.
- Browse an interactive version of the schema.
- View an example datastore file.
Validation
Datastore dataset files can be validated against the schema with:
- online validators (e.g., 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), or
- the
validate-tomlcommand line script that is installed when echoSMs is installed.
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).
Schema browser
Warning
The schema browser does not show property dependencies, such as when the presence of an optional
property requires that another property be present (e.g., if latitude is present,
then latitude_units is required). Such dependencies are given in the dependentRequired
sections of the datastore schema.