Improve route documentation
goncalossilva opened this issue · 0 comments
goncalossilva commented
Routes are all documented like so:
ffs/ffs-server/src/main/kotlin/routes/FlagRoutes.kt
Lines 87 to 96 in 474b689
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.