TabbycatDebate / tabbycat

Debating tournament tabulation software for British Parliamentary and a variety of two-team parliamentary formats
https://tabbycat.readthedocs.io/
GNU Affero General Public License v3.0
241 stars 799 forks source link

New API endpoint for current standings (only points) #2259

Open gserranof opened 1 year ago

gserranof commented 1 year ago

Hi there! This is a 2 in 1.

Firstly, just to point that the link provided for the Swagger schema at Readthedocs points to the v1.0 - I think it'd be way more useful if it'd point to the current v1.3.

Being said that, although it's nice to have the endpoint to the team standings, the main problem I find with it is that it returns the actual standings - that is to say, it doesn't care if a round is silent or not, so there's no way to get (afaik) the public standings, thus minimizing the use cases for that endpoint. If it'd instead retrieve the public ones, or at least could give that option, I think it'd broaden the appeal to make use of it.

That said, amazing job, for sure!

tienne-B commented 1 year ago

There will be no link to Swagger in the documentation for the next version. Rather, a schema visualizer will be included on every site: /api/schema/redoc/.

Interesting idea for a "current team points" endpoint!