Versions Compared

Key

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

...

There are two groups of endpoints:

  • Legacy - v1 to v3
  • REST - originally started at v4 but now starts at v1

Our new API philosophy is much more strict on adhering to RESTful principals and to versioning.

Endpoint versions

Tip
The general principal is that any particular endpoint is versioned independently of any others.

Each endpoint should begin at v1.

...

Info

We had been referring to the new REST endpoints as "v4" to try and prevent the situation where an upgrade path results in a version downgrade.  For example, upgrading v3 EPG to v1 Program Metadata.  This has caused confusion in client developers and so everything will start at v1is an inconsistency in our versioning philosophy.  We are rather using v1 as the first version for every endpoint, regardless of whether it is legacy or REST.

How upgrading and migration works with respect to versioning

...