Create coherent documentation for common APIs

[stephan418]

Using OpenAPI, a usable API documentation should be created for the most important API routes.

The API routes which should be tackled by this task are:

• Events (CRUD)

• Everything relating to user sign up

• [x] Test different strategies for writing the docs

Update

https://www.npmjs.com/package/express-oas-generator seems to fit most of our requirement

Todo:

• [x] Assess ways thorugh which our authentication strategy (bearer) can be included in the docs (possibly even manually)
• [x] Define a standard for restructuring the code so that all code paths in all handlers end in a call to next()
  • Idea: Extend the default .send() functionality in order to also call next()

[stephan418]

Task update (2)

The generation of documentation now works without restructuring any server code. I added more granular request handling support in a fork of the express-oas-generator library which fixes the problem for now at least.

New Tasks:

• [ ] Add support for bearer authorization (basically just prefix bearer to the token)
• [ ] Update the insomnia design document to include a test which runs all the requests in a meaningful order
• [ ] Add ability to handle picture uploads and the like (which are not handled by the fix I developed (Optional)

[stephan418]

Waiting for other task

Waiting for https://github.com/detleph/issues/issues/4