Api doc update

Description

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.

Changes

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

Additions

• 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

assigned to @leverse

added 42 commits

• f5a9c407...5fed8e55 - 41 commits from branch development
• 5ca6e1d1 - Merge branch 'development' into api-doc-update

Compare with previous version

"All endpoints are to be documented via javadoc, with some future tool translating this to proper REST documentation." Perhaps make an issue for this? We have something similar already with openAPI working in labracore btw.

Right now most controller actions already have valid javadoc, as this was a actually decision the team made way back. I'll create an issue for finishing this work and installing SpringDoc/OpenAPI as in Labracore.

mentioned in commit c74dbe33

merged

unassigned @leverse