Repository navigation
docs: describe the Debug API operations and parameters - #31514
Closed
nickvigilante wants to merge 2 commits into
Closed
nickvigilante wants to merge 2 commits into
nickvigilante wants to merge 2 commits into
Conversation
The REST API reference renders these routes from swagger.json, and they had no description. This adds one to each Debug route and improves the health check parameters. Part of DOCS-1439. Assisted-by: AI
Part of DOCS-1439. Assisted-by: AI
This was referenced Oct 29, 2026
Collaborator
Author
|
Combined into #31562, where this PR's changes are the commit Generated by Coder Agents on behalf of @nickvigilante. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Describes the five
DebugAPI routes and improves theforceand request body parameters, so the REST API reference page for each route has more than a title.The reference renders from
swagger.json, and these routes had no description.Merge notes
This PR doesn't touch #31473's exemption lists.
If #31473 merges first,
TestEndpointsDocumentednames each route on this PR to remove from those lists.Verification
A JSON diff of
swagger.jsonagainstorigin/mainchanges onlydescriptionvalues: 7 in total, all on routes in this PR or their parameters, and no other value differs.doc-check self-check
Ran the
doc-checkskill in author self-check mode on the branch diff, one persona at a time: Fact Checker, Continuity Editor, Copy Editor, then Skeptic on what survived. The other personas (Cartographer, Newcomer, Reader Advocate, Architect) didn't run.GET /api/v2/debug/healthsaid sections you dismissed are marked as dismissed, but the handler marks only five of the six sections and skipsprovisioner_daemons(coderd/debug.go:133-146). The sentence is removed.websocketslowercase againstWebSocketon other pages (no rule sets the casing).Claims checked against the code
/api/v2/debug/*routescoderd/coderd.go:2005(ResourceDebugInforead check in the/debugmiddleware),coderd/rbac/roles.go:422(Owner gets all permissions except the listed resources, andResourceDebugInfoisn't listed)GET /api/v2/debug/healthforce=trueruns a new checkcoderd/debug.go:83-90PUT /api/v2/debug/health/settingscoderd/debug.go:222,coderd/rbac/roles.go:495PUT /api/v2/debug/health/settings204when the settings don't changecoderd/debug.go:263PUT /api/v2/debug/health/settingsDERP,AccessURL,Websocket,Database,WorkspaceProxy,ProvisionerDaemonscodersdk/healthsdk/healthsdk.go:31-36Writing rules applied
api.Authorizecalls, middleware, andcoderd/rbac/roles.go.Annotation notes, not changed here:
GET /api/v2/debug/healthmarks only five of the six sections as dismissed and skipsprovisioner_daemons(coderd/debug.go:133-146).GET /api/v2/debug/healthalso accepts aformatquery parameter (jsonortext) that isn't annotated, and its error message listssimpleinstead oftext(coderd/debug.go).Part of DOCS-1439.
Generated by Coder Agents on behalf of @nickvigilante.