Skip to content

docs: describe the WorkspaceProxies API operations and parameters - #31535

Closed
nickvigilante wants to merge 1 commit into
mainfrom
vigilante/api-descriptions-workspaceproxies
Closed

nickvigilante wants to merge 1 commit into
mainfrom
vigilante/api-descriptions-workspaceproxies

Conversation

@nickvigilante

@nickvigilante nickvigilante commented Oct 29, 2026 •

Copy link
Copy Markdown
Collaborator

Adds a @Description to GET /api/v2/regions, which the dashboard's region picker and coder open app use.
The REST API reference renders this route from swagger.json, so it showed only a title.

Merge notes

This PR doesn't touch the exemption lists in #31473.
If #31473 merges first, TestEndpointsDocumented names each route on this PR to remove from those lists.

Verification

$ python3 check_routes.py <route list>
summary: need=1 problems=0 thin_params_left=0
$ go test ./coderd/coderdtest/ -run 'TestEndpointsDocumented|TestSDKFieldsFormatted' -count=1
ok  	github.com/coder/coder/v2/coderd/coderdtest
$ go test ./enterprise/coderd/coderdenttest/ -run TestEnterpriseEndpointsDocumented -count=1
ok  	github.com/coder/coder/v2/enterprise/coderd/coderdenttest
$ make lint/emdash
OK: no emdash or endash characters found.

The swagger.json diff against origin/main changes only a description value.

Doc-check self-check

Ran the doc-check skill in author self-check mode on the branch diff, one persona at a time: Fact Checker, Continuity Editor, Copy Editor, then Skeptic on the survivors.
No findings.
Skeptic rejected 0 findings.

Claims checked against the code
Route Claim Evidence
GET /api/v2/regions AGPL returns the primary region only coderd/workspaceproxies.go:78-94
GET /api/v2/regions Enterprise overrides the route and adds each proxy that isn't deleted or DERP-only enterprise/coderd/coderd.go:373-377, enterprise/coderd/workspaceproxy.go:53-80
GET /api/v2/regions Any authenticated user, no license gate on the route enterprise/coderd/coderd.go:374-376, coderd/workspaceproxies.go:80-83
GET /api/v2/regions healthy and the app URLs codersdk/workspaceproxy.go:185-202
GET /api/v2/regions Region picker and coder open app use it site/src/api/api.ts:2552-2558, cli/open.go:367-369
Writing rules applied
  • One to three present-tense sentences, first sentence starts with a verb and stands alone on the endpoint card.
  • No permission or license sentence beyond "Any authenticated user can call it", because the route has no gate.
  • Names which callers use the route.
  • Backticks around field names and commands.
  • No em dashes, en dashes, semicolons, or raw braces and angle brackets outside backticks.

Part of DOCS-1439.

Generated by Coder Agents on behalf of @nickvigilante.

The REST API reference renders these routes from swagger.json, and they had no description.
This adds a description for the regions route.

Part of DOCS-1439.

Assisted-by: AI
@linear-code

linear-code Bot commented Oct 29, 2026

Copy link
Copy Markdown

DOCS-1439

@nickvigilante

Copy link
Copy Markdown
Collaborator Author

Combined into #31562, where this PR's changes are the commit docs: describe the WorkspaceProxies API operations and parameters. The claims table above still covers that commit.

Generated by Coder Agents on behalf of @nickvigilante.

@github-actions github-actions Bot locked and limited conversation to collaborators Oct 30, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant