Document more club endpoints#36
Conversation
davidbmaier
left a comment
There was a problem hiding this comment.
Just a partial review since this is so much - I'll need to go through the club stuff later.
One quick thought about the scope of the clubs section: Can we maybe split it into "Clubs" and "Club management"? The former category can be the read-only endpoints, the latter can contain the endpoints that create/update/delete stuff the authenticated user owns. It's still gonna be a lot, maybe we could add another level of directories below that (at which point we could also stick to the existing "Clubs" directory and just split it in there).
davidbmaier
left a comment
There was a problem hiding this comment.
Okay, made it through the rest finally - lots of small stuff which isn't too surprising given the PR's size I guess.
There are a couple cases of information that might make sense in the central glossary but I'm happy to take another look at that later. Same thing for some phrasing/"you"/"your" since that's already inconsistent in existing stuff, and I'd really like to get this PR done first instead of adding more global changes to it.
|
I have pushed a commit addressing most review comments
I would like to do that. Would it be better to have a Management folder inside |
There was a problem hiding this comment.
Thanks for the adjustments, just a couple minor things to clean it up.
Would it be better to have a Management folder inside
clubs, or have the new folder outside it?
I think there's a few options that could make sense:
live/clubsandlive/club-managementis probably the cleanest split with both being easily accessible when looking at all Live endpointslive/clubs/managementfor management stuff andlive/clubs/???for everything else - dunno if we can find a good name for that second onelive/clubs/managementfor management stuff and everything else just goes intolive/clubs- not a big fan because the management folder is just a small entry in between random endpoints
So I'd say just a new separate directory should work fine.
This PR aims at documenting the endpoints used in-game for most club activities / functionalities.
Notes:
Special thanks to Ayr, Ezio, Zai, tooInfinite, and more for their help while documenting these endpoints.