Repository navigation
docs: describe the TemplateBuilder API operations and parameters - #31548
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. 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.
This PR adds descriptions for the 5
TemplateBuilderroutes and improves 4 of their parameters.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,
TestEndpointsDocumentednames each route on this PR to remove from those lists.Verification
A JSON diff of
coderd/apidoc/swagger.jsonagainstorigin/mainchanges onlydescriptionvalues on the routes in this PR.Claims checked against the code
--disable-template-builderbasefilters by the base's operating system and omits modules the base includes; unknown base returns 400base_template_idrequiredbase_template_id,organization_id, andnamerequiredsession_idandevent_type(wizard_entryorcompose_completion) requireddoc-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.
Permission checks, the 2 minute import timeout, the 404 when the builder is turned off, and the required fields match
coderd/templatebuilder_handler.goandcoderd/coderd.go:1686.Continuity Editor: No findings.
Copy Editor: No findings.
Skeptic: kept 0 and rejected 2.
One finding that Organization Auditor is missing from the read permission sentences, rejected because the sentences don't claim to be exhaustive and it is not a wrong claim.
One nbsp finding for "2 minutes", rejected because
Coder.UnitSpacingskips generated API pages.No blocking findings remain.
Writing rules applied
coderd/rbac/roles.goand the handler ordbauthzcheck.user,limit,offset) use the shared wording only where the handler matches it.Part of DOCS-1439.
Generated by Coder Agents on behalf of @nickvigilante.