Skip to content

docs: describe the Prebuilds API operations and parameters - #31551

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

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

Conversation

@nickvigilante

@nickvigilante nickvigilante commented Oct 29, 2026 •

Copy link
Copy Markdown
Collaborator

This PR adds descriptions for the 2 Prebuilds routes and improves the request body parameter.
The REST API reference renders these routes from swagger.json, and they had no description.

Merge notes

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

Verification

summary: need=2 problems=0 thin_params_left=0
ok  	github.com/coder/coder/v2/coderd/coderdtest	0.394s
ok  	github.com/coder/coder/v2/enterprise/coderd/coderdenttest	2.192s

A JSON diff of coderd/apidoc/swagger.json against origin/main changes only description values on the routes in this PR.

Claims checked against the code
Route Claim Evidence
GET /api/v2/prebuilds/settings, PUT /api/v2/prebuilds/settings Requires a Premium license (route sits behind RequireFeatureMW(FeatureWorkspacePrebuilds)) enterprise/coderd/coderd.go:741-748
GET /api/v2/prebuilds/settings Holds the reconciliation_paused flag; no further authorization check enterprise/coderd/prebuilds.go:24-50, codersdk/prebuilds.go:15-17, coderd/database/dbauthz/dbauthz.go:4815-4817
PUT /api/v2/prebuilds/settings Requires permission to update deployment configuration, which the Owner role has coderd/database/dbauthz/dbauthz.go:9772-9777, coderd/rbac/roles.go:422
PUT /api/v2/prebuilds/settings Returns 304 when settings are unchanged enterprise/coderd/prebuilds.go:90-94
PUT /api/v2/prebuilds/settings reconciliation_paused pauses reconciliation for all templates enterprise/coderd/prebuilds/reconcile.go:394-400, 1309-1321
doc-check self-check

Ran in author self-check mode on the branch diff, annotation text only: Fact Checker, Continuity Editor, Copy Editor, and then the Skeptic.
The other personas didn't run because no Markdown page was written by hand, and docs/reference/api/ is generated.
Fact Checker: No findings.
The Premium gate, the update permission, the 304 response, and the global scope of reconciliation_paused match enterprise/coderd/coderd.go:741-748 and enterprise/coderd/prebuilds.go.
Continuity Editor: No findings.
Copy Editor: No findings.
Skeptic: kept 0 and rejected 0.
No findings reached the Skeptic.
No blocking findings remain.

Writing rules applied
  • One to three present-tense, active-voice sentences, addressed to "you", with the first sentence starting with a verb.
  • Permission sentences name the built-in roles by display name, each traced to coderd/rbac/roles.go and the handler or dbauthz check.
  • Premium license, experiment, and authentication sentences appear only where the code gates the route.
  • Streams say that the route upgrades to a WebSocket and what each message carries.
  • Full API paths and exact field names, parameter names, and values are in backticks.
  • Parameter text states what the value selects, its accepted forms, and its default and limits from the code.
  • Shared parameters (user, limit, offset) use the shared wording only where the handler matches it.
  • No em dashes, en dashes, spaced double hyphens, semicolons in prose, or raw angle brackets and braces 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.

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 Prebuilds 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