Add openAPI/Swagger documentation for the endpoints

[perrauer]

Please consider adding openAPI documentation for the endpoints and make it available on e.g. the /swagger path.

I'm happy to see frequent updates to this awesome project but it can be a struggle to keep documentation and implementation in sync.
E.g I can't get the the GET /api/events to work given the current documentation

[spikelu2016]

Hey Per, it is a good point. Might take some time to make this happen. May I ask what is the error code and error message for GET /api/events failure?

[perrauer]

Yes, openAPI/Swagger really helps with integration and it lives with the code - or if you prefer design-before-code, in the specifications.

In the end it turned out that I sent parameters in the request body instead of the query so Mea Culpa. The error code indicated missing parameters and I made futile changes to the request body. But on the other hand, the new /api/v2/events didn't make it to the documentation ;o)

I hope it's Ok that I post a few more suggestions. My own Golang journey is brief and steep, but I like the language and development model.

/Per

[spikelu2016]

You should definitely post more suggestions because we want to improve the product as much as we can. The v2 endpoint is still subject to change which is why I haven't documented it yet.

[spikelu2016]

Update: Just added documentation for the v2 events API