This repository contains schemas and code to support validation of data published according to the Modelling Opportunity Data specification.
The schemas are provided to allow users to validate code using their own tools. While the application will provide a public endpoint with additional functionality.
The schema uses the JSON Schema vocabulary to validate JSON documents.
It's intended to support validation of JSON-LD documents that conform the the Modelling Opportunity Data specification.
The opportunity data specification uses properties from Schema.org and the the OpenActive vocabulary to describe a number of different types of resource, e.g. Events, Places, Activity Lists, etc.
By default, the initial version of the schema focuses on validating a JSON-LD document which consists of an Event with nested descriptions of Places, etc.
If you're validating data with a different entrance point then change the top-level $ref property to refer to one of the other definitions. For example if you want to validate a Place, then change the schema to this:
{
"$schema": "http://json-schema.org/schema#",
"title": "Modelling Opportunity Data Schema",
"$ref": "#/definitions/place",
...
}
By default the schema checks for strict conformance to the opportunity data specification. This means it will reject custom properties or additional properties from Schema.org. To make the schema more lax, then change the additionalProperties value to true in the relevant definition(s).
This type of switching will be handled automatically by the validation application. These notes are provided for people doing manual testing.
If you're doing manual checking of the data then you can use the following tools:
- JSONLint for basic JSON syntax checking
- JSON-LD playground will check basic JSON syntax and will also ensure documents are valid JSON-LD
- JSON Schema Lint for validating a JSON-LD document against the schema
JSON Schema Lint allows you to paste in the schema and a sample document and will give live validation messages as you revise the document.
There's a crude validator interface available at https://oa-validator-experimental.herokuapp.com/ (WARNING: URL will change in future).
This uses the AJV library to do validation of JSON adding to the textarea.
It currently supports switching the validation context as described above so you can validate an Event, Place, etc. There is also a lax mode which will ignore any unknown properties (use with care!)
There are lots, have a look at the open issues. Especially the schema improvements.