SuperEvilMegacorp / vainglory-assets

Community provided art, schemas, and other assets that make using the Vainglory API easier
https://developer.vainglorygame.com
MIT License
54 stars 40 forks source link

Proposal: Versioning #287

Closed svperfecta closed 7 years ago

svperfecta commented 7 years ago

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:

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.

svperfecta commented 7 years ago

This issue was moved to gamelocker/platform#1