Repository navigation
docs: describe the Provisioning API operations and parameters - #31519
Closed
nickvigilante wants to merge 1 commit into
Closed
nickvigilante wants to merge 1 commit into
nickvigilante wants to merge 1 commit into
Conversation
The REST API reference renders these routes from swagger.json, and they had no description. This adds one to each Provisioning route and improves the parameter descriptions. 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
GET /api/v2/organizations/{organization}/provisionerdaemonsand improves itsorganizationandlimitparameters, so the REST API reference page for the route has more than a title.The reference renders from
swagger.json, and this route 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.organizationtext names a name anddefaultwhile the annotation saysformat(uuid). The shared wording is mandated where the route usesExtractOrganizationParam, and types are out of scope.The
idsandstatusparameters are untouched because #30124 and #30122 change them.Claims checked against the code
GET /api/v2/organizations/{organization}/provisionerdaemons404without itcoderd/provisionerdaemons.go:42-45,coderd/rbac/roles.go:414-422(Owner has all permissions except a list that excludes neither resource),coderd/rbac/roles.go:601(Organization Admin,ResourceProvisionerJobsisn't excluded),coderd/rbac/roles.go:693(Organization Template Admin)GET /api/v2/organizations/{organization}/provisionerdaemonsResourceProvisionerJobspermissioncoderd/rbac/roles.go:507-526organizationpath parameterdefaultcoderd/coderd.go:1567(ExtractOrganizationParam),coderd/httpmw/organizationparam.go:67-90limitquery parameter50, and0returns all resultscoderd/provisionerdaemons.go:49(PositiveInt32(qp, 50, "limit")),:71(Valid: limit > 0)GET /api/v2/organizations/{organization}/provisionerdaemonscoderd/provisionerdaemons.go:84-113Writing rules applied
api.Authorizecalls, middleware, andcoderd/rbac/roles.go.Annotation notes, not changed here
offlineandmax_agequery parameters that have no@Param, and it rejects any other query parameter (ErrorExcessParams).organizationparameter hasformat(uuid), but the middleware also accepts a name ordefault.idstext says "job IDs", but the handler passes the IDs to the daemon query.Part of DOCS-1439.
Generated by Coder Agents on behalf of @nickvigilante.