Repository navigation
docs: describe the proxy, provisioner key, and replica API operations - #31525
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 descriptions and fuller parameter text for workspace proxies, provisioner keys, the provisioner daemon connection, and replicas. Part of DOCS-1439. Assisted-by: AI
A doc-check self-review found a description line with two sentences, an ambiguous workspace proxy permission sentence, and a confusing provisioner key path parameter. Part of DOCS-1439. Assisted-by: AI
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.
Adds
@Descriptiontext to the 12 workspace proxy, provisioner key, provisioner daemon, and replica routes that had none, and replaces thin or incomplete parameter text on those routes.The REST API reference renders these routes from
swagger.json, so they showed only a title.Merge notes
This PR doesn't touch the exemption lists in #31473.
If #31473 merges first,
TestEndpointsDocumentednames each route on this PR to remove from those lists.Verification
Head `20029fb19c`, after the self-check commit.
The
swagger.jsondiff againstorigin/mainchanges onlydescriptionvalues (24 changed, proven with a JSON walk that fails on any other change).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 the survivors.Fixed 1 blocking finding (a
@Descriptionline with two sentences onPOST /api/v2/workspaceproxies) and 2 suggestions (theprovisionerkeypath text onGET /api/v2/provisionerkeys/{provisionerkey}, and the permission sentence onGET /api/v2/workspaceproxies).Skeptic rejected 0 findings.
Annotation bugs noticed, not fixed here
GET /api/v2/provisionerkeys/{provisionerkey}: the handler ignores the path value and returns the key from theCoder-Provisioner-Daemon-Keyheader.GET .../provisionerdaemons/serve:organizationcarriesformat(uuid), but the route accepts an ID, name, ordefault. The query parametersprovisioner,name,version, andtaghave no@Paramlines..../workspaceproxies/{workspaceproxy}:workspaceproxycarriesformat(uuid), but the route accepts an ID, name, orprimary.Claims checked against the code
GET /api/v2/organizations/{organization}/provisionerdaemons/serveenterprise/coderd/coderd.go:617,enterprise/coderd/provisionerdaemons.go:41-50(provisionerDaemonsEnabledMW)GET .../provisionerdaemons/serveenterprise/coderd/provisionerdaemons.go(websocket.Accept,yamux.Server,drpcmux)GET .../provisionerdaemons/servecoder provisioner startconnects hereenterprise/cli/provisionerdaemonstart.go:227,codersdk/provisionerdaemons.go:298GET .../provisionerdaemons/servecodersdk/client.go:99-103,codersdk/provisionerdaemons.go:320-330,enterprise/coderd/coderd.go:617-627GET .../provisionerdaemons/servetagnot allowed with a key, key's organization appliesenterprise/coderd/provisionerdaemons.go:83-93GET .../provisionerdaemons/serveenterprise/coderd/provisionerdaemons.go:96-100GET .../provisionerdaemons/servescope=useropen to any user, other scopes need create on provisioner daemonsenterprise/coderd/provisionerdaemons.go:127-140,provisionersdk/provisionertags.go:6-10GET .../provisionerdaemons/servecoderd/rbac/roles.go:508-520(Template Admin),coderd/rbac/roles.go:421-432,596-625(Owner, Organization Admin),coderd/rbac/roles.go:679-690(Organization Template Admin)GET .../provisionerdaemons/serveprovisioner,name,version,tagenterprise/coderd/provisionerdaemons.go:162-250GET .../provisionerdaemons/serveorganizationtakes ID, name, ordefaultenterprise/coderd/coderd.go:625(ExtractOrganizationParam),coderd/httpmw/organizationparam.go:54-85POST,GET,GET .../daemons,DELETEon/api/v2/organizations/{organization}/provisionerkeysenterprise/coderd/coderd.go:589-594(FeatureExternalProvisionerDaemons)coderd/database/dbauthz/dbauthz.go:2704,6848,7417-7423,coderd/database/modelmethods.go:676-680,coderd/rbac/roles.go:508-520POST .../provisionerkeysbuilt-in,user-auth, orpsk, 409 on duplicatesenterprise/coderd/provisionerkeys.go:56-95,codersdk/provisionerdaemons.go:397-409POST .../provisionerkeysenterprise/coderd/provisionerkeys.go:78,102,enterprise/coderd/provisionerkeys.go:269(convert comment)GET .../provisionerkeysenterprise/coderd/provisionerkeys.go:123,284,coderd/database/dbauthz/dbauthz.go:7421GET .../provisionerkeys/daemonsuser-authkey and recently seen daemonsenterprise/coderd/provisionerkeys.go:151-193DELETE .../provisionerkeys/{provisionerkey}enterprise/coderd/provisionerkeys.go:219-238GET /api/v2/provisionerkeys/{provisionerkey}Coder-Provisioner-Daemon-Keyheader and returns that key, ignoring the path valueenterprise/coderd/coderd.go:574-583,enterprise/coderd/provisionerkeys.go:255-266GET /api/v2/replicasenterprise/coderd/replicas.go:25,coderd/rbac/roles.go:421-432GETandPOST /api/v2/workspaceproxies,GET,PATCH,DELETE .../{workspaceproxy}enterprise/coderd/coderd.go:413(FeatureWorkspaceProxy)GET /api/v2/workspaceproxiescoderd/rbac/roles.go:446-455,coderd/database/dbauthz/dbauthz.go:6190GET /api/v2/workspaceproxiesenterprise/coderd/workspaceproxy.go:455-475POST /api/v2/workspaceproxiesprimaryreserved, token returnedcoderd/database/dbauthz/dbauthz.go:7219,enterprise/coderd/workspaceproxy.go:350,401-407PATCH .../{workspaceproxy}regenerate_token, primary onlydisplay_nameandiconcoderd/database/dbauthz/dbauthz.go:9439,enterprise/coderd/workspaceproxy.go:125,173-175,189-215DELETE .../{workspaceproxy}coderd/database/dbauthz/dbauthz.go:9446,enterprise/coderd/workspaceproxy.go:271.../{workspaceproxy}primarycoderd/httpmw/workspaceproxy.go:177-186organizationon provisioner key routesdefaultenterprise/coderd/coderd.go:589,coderd/httpmw/organizationparam.go:54-85Writing rules applied
dbauthzandroles.go.RequireFeatureMWor an entitlement middleware.Coder-Provisioner-Daemon-KeyandCoder-Provisioner-Daemon-PSKheaders.organizationwording, only where the route usesExtractOrganizationParam./api/v2paths and backticks around field names, enum values, and flags.Part of DOCS-1439.
Generated by Coder Agents on behalf of @nickvigilante.