Repository navigation
docs: describe the Applications API operations and parameters - #31522
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 Applications route and improves the parameter descriptions. 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 two
ApplicationsAPI routes and improves theredirect_uriparameter, 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: 3 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.redirect_uritext saidRequiredwhile the same row showsRequired: false. The text now says what the route does without the word (the annotation bug is listed below).Claims checked against the code
GET /api/v2/applications/hostcoderd/workspaceapps.go:39,coderd/workspaceapps/appurl/appurl.go:43-46GET /api/v2/applications/host/api/v2/regionsand the primary workspace proxy'swildcard_hostnamecoderd/workspaceapps.go(@Deprecatedannotation),codersdk/workspaceproxy.go:197-201GET /api/v2/applications/auth-redirectcoderd/coderd.go:1965(apiKeyMiddlewareRedirect),coderd/coderd.go:1119-1122(RedirectToLogin: true)GET /api/v2/applications/auth-redirectapplication_connectscope and expires with your session or after the default session duration, whichever comes firstcoderd/workspaceapps.go:112-122GET /api/v2/applications/auth-redirectredirect_uriquery and redirectscoderd/workspaceapps.go:147-154redirect_uriquery parameter400when it's missing, and it must be the primary wildcard app hostname, a workspace proxy access URL, or a workspace proxy wildcard app hostnamecoderd/workspaceapps.go:71-74,:86-100Writing rules applied
api.Authorizecalls, middleware, andcoderd/rbac/roles.go.Annotation bugs noticed, not changed here
GET /api/v2/applications/auth-redirectdocuments307, but the handler redirects with303(http.StatusSeeOther,coderd/workspaceapps.go:154).redirect_uriis marked optional, but the handler returns400without it.Part of DOCS-1439.
Generated by Coder Agents on behalf of @nickvigilante.