Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Customer champions

CustomerChampion
DNA
Delta
Viacom
BooxTV


How to version the API

Versions and URLs

A version MUST include a major and minor portion, for example: 2.1 

...

Each endpoint MAY have it's own version (and doesn't have to share a version with a group of endpoints, e.g.: recordings/search can be different version from recordings/play)

Changing versions

All changes to API code MUST be regression tested by the implementor against all projects

...

The effect of this is that all the minor versions within a major version MUST be backwards compatible

Documenting

Each endpoint MUST have a version that is documented in the Jenkins generated documentation

Each endpoint MUST be documented on this Confluence page ("Move API version tracking")


Versions in use

Please see List of endpointsEndpoints in production use