Skip to content

Api doc update

Luc Everse requested to merge api-doc-update into development


Updates the API documentation to reflect the true output.

This will be the last update to this form of API documentation. All endpoints are to be documented via javadoc, with some future tool translating this to proper REST documentation.


  • The file is standalone; just the index.html is sufficient to view the docs with full functionality.


  • Missing fields here and there.
  • More examples.

Test and Review

To be filled in by the reviewers

  • There are no unnecessary files present in the MR

  • The continuous integration has no problems with the MR

  • The MR is filled in as requested (including labels, milestones, and reviewers)

  • The documentation is up-to-date

Merge request reports