lichess-org / api

Lichess API documentation and examples
https://lichess.org/api
GNU Affero General Public License v3.0
417 stars 140 forks source link

Lichess API documentation for simuls not correct #254

Closed draconicfae closed 1 year ago

draconicfae commented 1 year ago

Exact URL of where the bug happened

https://lichess.org/api#tag/Simuls/operation/apiSimul

Steps to reproduce the bug

read documentation and contrast it to actual API results for a call to /api/simul

What did you expect to happen?

Data returned should match the specification, which is, an array of dictionaries with each dictionary detailing a particular simul which would then be iterated in a flat fashion

What happened instead?

an array of four dictionaries, "pending", "created", "started", "finished", each of which needs to be iterated separately to scoop out all the data

Operating system

Linux

Browser and version (or alternate access method)

no browser

Additional information

I should note that I'm not claiming that what actually happens is bad or needs to be reverted to match the documentation, but rather just that the documentation should be updated to reflect what actually happens.