Versions Compared

Key

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

...

CustomerChampion
DNA
Delta
Viacom
BooxTV


How to version the API

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

The version of the API MUST change if there is any change to the endpoint request or response formats

All micro versions of the API MUST be backwards compatible within the minor version 

All micro version changes MUST be regression tested by the implementor against all projects

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

Each endpoint MAY have it's own version


Version usage

GroupEndpointDNADeltaViacomBooxTV
EPG/epg



Recordings/recording/search




/recording/catchup




/recording/{program}




/recording/{program}/playback




/recording/favorite



Channel/channel



Subscription/license/status



Miscellaneous/category



...