Academy Ruins API v0.2.0
BREAKING CHANGES
All of the routes in the Rules section of the API have been deprecated and replaced with new routes. The deprecated routes are scheduled to be removed on 2023-07-01. The responses returned by the new routes are identical to their old counterparts, only the path has been changed.
Replacements
The routes are changed as follows:
/allrules➡️/cr/rule/{num}➡️/cr/{num}/example/{num}➡️/cr/example/{num}/keywords➡️/cr/keywords/glossary➡️/cr/glossary/glossary/{term}➡️/cr/glossary/term/unofficial-glossary➡️/cr/unofficial-glossary
Rationale
When Academy Ruins was first created, it was a rushed patch job trying to replace an old, suddenly unavailable API as fast as possible. In order to make the transition easier for projects, I tried to replicate 1:1 the paths that the old API was serving. With time to reflect though, I came to realize that those paths were not a great fit for what my goals are for Academy Ruins. As I plan to extend the API to include things like the parsed MTR (which is coming Soon:tm:) and IPG (and more), the specter of those old routes polluting the global namespace seems less and less bearable. Therefore, while the project is still in its fairly early stages, I decided to properly re-organize those responses into a more sensible schema.
Hopefully, since the transition should be fairly simple, six months are enough for anyone who depends on these routes to make the switch.
Other Changes
- Added the
/file/crroute returning the latest raw CR file. - The API docs have been improved to properly describe most of the site's behavior.
- Reworked the CR parser to more intelligently determine the character encoding of the source file.