Skip to content

Latest commit

 

History

History
83 lines (55 loc) · 4.2 KB

json_schema_version_updates.md

File metadata and controls

83 lines (55 loc) · 4.2 KB
Raw

JSON Schema version updates

Upgrading the BODS schema

Work through all of the JSON schema terms we use in the BODS schema, and find out if any of them:

  1. have been deprecated or replaced.
  2. have changed in meaning or usage.

Then review any major changes between the two JSON schema versions, and assess if there are any new terms or features we can make use of to improve our ability to validate data against the BODS schema.

Validation and testing

The tests import a specific validator version from the Python jsonschema library. This will need to be updated when the version of JSON Schema used changes.

We extend JSON Schema with a few custom properties which are applied in the metaschema. The file meta-schema.json (found in data-standard/tests/schema) contains a copy of the current JSON Schema version, plus the custom properties. This will need to be updated when changing the JSON Schema version.

For a description of custom properties currently in use, see Metaschema.

It's likely that the testing dependencies of jsonschema and JSCC will need to be updated to accommodate JSON Schema version upgrades.

Migrating the data

Updating the BODS schema to use a later version of JSON Schema may mean that BODS data which conforms to the old version of the BODS schema is no longer conformant; in this case, the BODS schema update is non-backwards-compatible. It is advisable to couple any non-backwards-compatible JSON Schema updates with a version update to BODS as a whole, so that published data does not need to be migrated to remain valid.

Data used for examples and testing will need to be migrated to the new version.

Changes which affect a small number of data items may be simple to make by hand. Changes which affect large numbers of data items, or which are complex, may need to be scripted. When updating the JSON Schema version, keep track of how the changes may affect existing data, and provide guidence or scripts for data migration if necessary.

Update json pointers in the BODS documentation

If changes to JSON Schema properties have been made, json pointers used in Sphinx directives may no longer resolve. This will cause the documentation build process to fail. As of 2023-10, there is extensive use of json pointers on the reference.rst page of the documentation.

Update from draft-04 to 2020-12

The JSON Schema version update was applied to version 0.3 of the BODS schema.

Changes

| From | To | Notes | | ==== | == | ===== | | id | $id | Must resolve to an absolute URI. Should not contain a fragment. | | definitions | $defs | | | exclusiveMinimum, exclusiveMaximum | changed from bool to number | "wherever one of these would be true before, change the value to the corresponding "minimum" or "maximum" value and remove the "minimum"/"maximum" keyword" | | items | prefixItems | not applicable to BODS 0.3 | | additionalItems | items | not applicable to BODS 0.3 | | enum | const | where enum contains one element |

Additions

New terms/functionality that may be useful:

  • contains, maxContains, minContains
  • const
  • duration
  • uuid
  • date
  • time
  • regex
  • if/then/else
  • examples
  • $comment
  • $vocabulary for metaschema

(This section will be updated as new terms are integrated into the BODS schema)

Documentation

  • Update schema documentation about minimum/exclusiveMinimum/maximum/exclusiveMaximum
    • While you can specify both of minimum and exclusiveMinimum or both of maximum and exclusiveMaximum, it doesn’t really make sense to do so.
    • Interest / share / maximum has gone from exclusive by default to inclusive. exclusiveMaximum now needs to be used instead

Data

  • change maximum to exclusiveMaximum, unless:
    • it's representing exact values
    • exclusiveMaximum is present and set to false
  • if exclusiveMaximum is present and set to false:
    • remove the boolean exclusiveMaximum
  • if exclusiveMinimum was set to true:
    • change minimum to exclusiveMinimum and remove the boolean exclusiveMinimum

In the BODS schema, this is applicable to Interest / share / maximum and Interest / share / minimum.