speedcontrol / nodecg-speedcontrol

NodeCG bundle to help facilitate the running of speedrunning marathons, including overlays.
MIT License
44 stars 34 forks source link

Missing version header for oengus api #115

Closed duncte123 closed 2 years ago

duncte123 commented 3 years ago

Since oengus is moving to version 2.0 soon the API will change as well. To handle the new responses that v2 will need we have implemented a header to define the response type for the API. Because that transition will happen before official documentation is released I suggest using the header oengus-version: 1 when making requests to the oengus API. This will ensure that speedcontrol will get consistent data that will not break randomly with oengus updates since version 2 will become the default.