chore(docs): document agent api debug endpoints #14454
Conversation
|
All contributors have signed the CLA ✍️ ✅ |
|
I have read the CLA Document and I hereby sign the CLA |
There was a problem hiding this comment.
LGTM
For now this is just handwritten (so no Swagger involved) documentation.
It would be helpful if you clarified what exactly was manually written, if not all of it.
One other thing to check is that this won't be overwritten by running make coderd/apidoc/swagger.json and other targets which produce docs.
I just ran |
relates to #14362
For now this is just handwritten (so no Swagger involved) documentation. It covers the four agent debug endpoints:
/debug/logs,/debug/magicsock,/debug/magicsock/debug-logging/{state}and/debug/manifest.Future work should aim to include how and when to use the API.