Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document status endpoint #43

Closed
pennyarcade opened this issue May 16, 2023 · 1 comment
Closed

Document status endpoint #43

pennyarcade opened this issue May 16, 2023 · 1 comment

Comments

@pennyarcade
Copy link

https://api.spacetraders.io/v2/ is undocumented.
While you are at it also consider streamlining Leaderboard entries as to use only one DTO for all leaderboards:

class Entry {
string $agentSymbol;
int $value;
}

The meaning of $value is derived and directly dependent on the leaderboard type, naming the $value differently for every leaderboard does not add information.

This simplifies leaderboard handling on client side as you can use generic code for everything but the headline.

@space-admiral
Copy link
Contributor

Thanks for reporting this! We documented the endpoint in the last reset, let me know what you think. I didn't get to the second half of your suggestion to make it a generic type - we're not sure just yet how the leaderboard is going to evolve, but I could see us optimizing this down the road.

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

No branches or pull requests

2 participants