Skip to content

Improve documentation of the REST API #43

Description

@CrsiX

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?

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions