📝 Updated api documentation

[tjarbo]

Description

As part of #130, many api endpoints were replaced by new ones. This updated includes the updated version of the api documentation available on /api/docs. I double checked it to ensure every endpoint is correctly displayed but maybe you have the time to check this again - it always easy to overlook something 😅 Thank you!

The documentation is buold with stoplight.

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Code style update (formatting, renaming)
• Refactoring (no functional changes, no api changes)
• Build related changes
• Documentation content changes
• Other (please describe):

Checklist

• Make sure you are requesting to main. Don't request to release branch!
• I have linked the related issue.
• My code follows the code style of this project.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have added tests to cover my changes.
• All new and existing tests passed.

[tjarbo]

@p-fruck you mentationed, that you know a package that uses jsdocs comments or something like that to generate an api docu from comments - which was it ?

[p-fruck]

@tjarbo once upon a time I used to use swagger-jsdoc in combination with swagger-express-ui. StudyOffline is an example project using this setup. You can see the swagger-ui being served using express as well as our swagger documentation being written inline as comments for the express router functions. Note that the swagger documentation is generated at runtime, not at compile time, in the example project.

[p-fruck]

I like to complain about newline, but for some reasons vscode removes them automatically from json documents. Actually, the reason is quite valid, but nevertheless I'd like to request this newline.

[tjarbo]

Added with 180b964