Skip to content

Document more club endpoints#36

Merged
davidbmaier merged 22 commits intoopenplanet-nl:mainfrom
Fort-TM:new-endpoints
Mar 29, 2026
Merged

Document more club endpoints#36
davidbmaier merged 22 commits intoopenplanet-nl:mainfrom
Fort-TM:new-endpoints

Conversation

@Fort-TM
Copy link
Copy Markdown
Contributor

@Fort-TM Fort-TM commented Mar 1, 2026

This PR aims at documenting the endpoints used in-game for most club activities / functionalities.

Notes:

  • This was mostly done by using HTTP Inspector + Nadeo API Console in-game. As such, the remark about dedicated server accounts are mostly guesses based on the endpoints requiring a club role or returning information about the authenticated player.
  • Most endpoints were tested on a personal club, with the responses reflecting that.
  • While some club endpoints look similar to some non-club endpoints in structure, their behavior can be different in some aspects. For example, the campaign club leaderboard doesn't have a max length value compared to the normal campaign leaderboard endpoint.
  • The Map Review endpoint had parameters listed that are actually only used in the Club Map Review endpoint. The game seems to pass the same parameters for multiple endpoints, despite not having any purpose in some of them (I saw that a lot when using HTTP Inspector).
  • I understand, with the addition of these endpoints, that the club endpoints section is getting too long. It might be better in the future to split them between activity types?
  • This required a lot of copy-pasting for certain endpoints. As such, there might be some mistakes, but I have tried to check for all of them. Apologies beforehand regardless 😅

Special thanks to Ayr, Ezio, Zai, tooInfinite, and more for their help while documenting these endpoints.

@Fort-TM Fort-TM mentioned this pull request Mar 1, 2026
Copy link
Copy Markdown
Member

@davidbmaier davidbmaier left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

Copy link
Copy Markdown
Member

@davidbmaier davidbmaier left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@Fort-TM
Copy link
Copy Markdown
Contributor Author

Fort-TM commented Mar 25, 2026

I have pushed a commit addressing most review comments

Can we maybe split it into "Clubs" and "Club management"?

I would like to do that. Would it be better to have a Management folder inside clubs, or have the new folder outside it?

Copy link
Copy Markdown
Member

@davidbmaier davidbmaier left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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/clubs and live/club-management is probably the cleanest split with both being easily accessible when looking at all Live endpoints
  • live/clubs/management for management stuff and live/clubs/??? for everything else - dunno if we can find a good name for that second one
  • live/clubs/management for management stuff and everything else just goes into live/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.

@davidbmaier davidbmaier merged commit 639a4fd into openplanet-nl:main Mar 29, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants