Document /_inspect/requests management endpoint
All of our Go services (controller, keep-web, keepstore, ...) offer this management API, but API/admin docs currently don't mention it.
Updated by Brett Smith 7 months ago
Tom Clegg wrote in #note-7:
20229-doc-inspect-requests @ a09cc1eec4f13db73269b2c282e8157a02a50682
This is great, I just have minor copyediting/clarification suggestions. Please take the suggestions that make sense, leave the ones that don't, and merge.
- Can the curl command be colored/highlighted to indicate user input? Would be nice to highlight the token and port number need changing. Maybe
0.0.0.0too? Honestly not sure about that part.
/_inspect/requestsendpoint" table header → "Provides
/_inspect/requestsendpoint" or similar, a verb to add context to the checkmark
- If there's a reasonable way to limit the table width to what's necessary that would be a nice affordance. Right now on a 16:9 browser window the checkmarks get pretty far from the service names.
- "Example" header → "Example response" or "Example report", something like that.