Doist/ffs

Improve route documentation

goncalossilva opened this issue · 0 comments

Routes are all documented like so:

/**
* Create a new flag.
*
* On success, responds `201 Created` with an empty body.
*
* | Parameter | Required | Description |
* | ----------------- | -------- | ------------------ |
* | `name` | Yes | Name of the flag. |
* | `rule` | Yes | Rule of the flag. |
*/

There are several problems with this, like:

  • Route documentation should be more easily accessible, i.e., in the public docs.
  • All request parameters are documented, Query parameters are hit-or-miss.
  • There is no example of what the full endpoint looks like in the docs themselves.