Proposal for unified model

[nickevansuk]

The idea is to create a single model version that exists to support the specifications, based on the various namespaces. This model version can be used to generate tooling and documentation, and to power the validator. It also ensures consistency in the model across the specifications.

Working draft below:

Specifications: Behaviour and usage of the Models

• [VERSIONED: 2.1] Modelling Opportunity Data
• [VERSIONED: 1.0 CR] Open Booking API
• [VERSIONED: 0.1 ED] Dataset API Discovery
• [VERSIONED: 0.1 ED] Route Guide
  • These all are linked from guides etc within the documentation

Model: Classes and properties with descriptions and strict type rules

• [VERSIONED: 2.0.14] OpenActive Model
  • Includes references to both https://openactive.io/ and https://schema.org namespaces
  • Includes strict type rules based on the namespaces (captured in model files) (re: arrays and selected properties)
  • Includes a subset of the terms in the namespaces
  • Drives libraries in multiple languages and validator
  • Auto-generated developer documentation of the model (so this is our equivalent of the website https://schema.org/). Note it’s more useful to have the developer docs at this level rather than the level below, as the namespace is underspecified for any practical purpose
  • Based on model files (https://github.com/openactive/data-models/)

Namespaces: JSON-LD namespaces

• [VERSIONED: (for consistency?)] https://openactive.io/: Classes and properties with descriptions for JSON-LD namespace oa:: OA Namespace (output from tooling, but only a subset of the above)
  • Perhaps the versions of these are less relevant to us, so we just treat this as a JSON-LD hygiene factor unversioned
  • Can be simply created by autogenerating an updated version of https://openactive.io/ns
• [VERSIONED: 3.7] https://schema.org: Schema.org properties
• SKOS