Skip to main content

Versioning

Our site provides versioned links to our JSON so that we have room for making breaking changes. We consider breaking changes to be:

  • renaming object fields on already published resources
  • changing the meaning, intent or expectation of an already published field or resource from what was previously documented

Things we don't consider to be breaking changes:

  • correcting or changing values for a previously reported field
  • adding new fields to an object that was previously published so long as it doesn't cause significant impact to an existing API's use (ie: download size)

Upgrading a Dataset‚Äč

When we issue a new version for an existing dataset, we update all references in our website documentation to the latest version to encourage migration. Generally, all that's required there is updating the reference to the enum value suffix representing the dataset version in the relevant doc mdx, for example:

<JSONFileLinks resource="CasualtiesDaily_V2" />

Here's an example commit introducing some new resource versions where you'll see the same doc updates.