Proposal: Versioning

[svperfecta]

From @genexp on September 6, 2017 14:31

Versioning of the API has been inconsistent (a really nice way of saying "it's a mess").

Right now the version encodes three bits of data:

• Changes to the version of the game itself - Sometimes forces new data
• Changes to the version of the API - New functionality, bug fixes to params, etc.
• Changes to the version of the way game data is presented - Ideally this will coincide with a game release, but a new game release doesn't change the game data necessarily.

We plan to update status as follows:

1. Status will now require a JWT. Anyone accessing it should have one anyways.
2. Since JWT is required, status will now be scoped to the titleID like all other endpoints.
3. ID will change to "titleID" to reflect the change. In the case of Vainglory it will be "semc-vainglory"
4. The response will be updated to include all version values:

{  
   "data":{  
      "type":"status",
      "id":"semc-vainglory",
      "attributes":{  
         "apiVersion":"v7.2.1",
         "patchVersion":"v7.2.1"
         "schemaVersion":"v7.2.1"
      }
   }
}

The plan is to roll this out in October with the new data pipeline changes, and Game 2.

Copied from original issue: gamelocker/vainglory#287