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.

Sign up for GitHub

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

Jump to bottom

Improve documentation of the REST API #43

Open

CrsiX opened this issue Jun 3, 2023 · 0 comments

Labels

Member

CrsiX commented Jun 3, 2023

It was requested to properly document the functionality of the REST API in order for third parties to fully understand and possibly re-implement it.

What is each endpoint doing exactly?
What are the response structs used for? (A single line is fine for helper structs, but not necessarily for actually used objects, like for example players, chats or games.)
How is the authentication flow?
What are the WS messages used for and when? Also include their docs in the REST API, if possible?

CrsiX added the documentation label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment