serokell / coffer

Multi-backend password store with multiple frontends
4 stars 2 forks source link

Generate documentation for the Web API #114

Closed dcastro closed 2 years ago

dcastro commented 2 years ago

Clarification and motivation

We should generate some document that details which endpoints our API supports, what they expect and what they return.

I think we can use servant-openapi3 to automatically generate Swagger docs. Let's give it a try.

Acceptance criteria

We have documentation detailing the Web API interface.