speedruncomorg / api

REST API Documentation for speedrun.com
346 stars 36 forks source link

Document durability of entity IDs (e.g. platform IDs) #76

Open retroph opened 6 years ago

retroph commented 6 years ago

On 2018-07-18 all platform IDs changed (presumably regenerated during to some database migration?). This event combined with the #75 bug on filter values made previously working requests of runs filtered by platforms suddenly returned all runs. I don't know if IDs are actually intended to be permanent and maybe this platform ID change was just an incident.

If platform IDs and other internal IDs cannot be assumed to be permanent, the documentation should state that those values should not be cached and cannot be reused safely.