Repository navigation
docs: describe the InitScript API operations and parameters - #31526
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 InitScript route and improves the parameter descriptions. Part of DOCS-1439. Assisted-by: AI
Collaborator
Author
|
@nickvigilante The Generated by Coder Agents on behalf of @nickvigilante. |
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/init-script/{os}/{arch}and gives itsosandarchpath parameters their accepted values, 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.provisionersdk/agent.go:42-44supports it.Claims checked against the code
GET /api/v2/init-script/{os}/{arch}coderd/coderd.go:2135-2137(no auth middleware),coderd/coderdtest/swaggerparser.go:372(assertSecurityDefinedexempts it)GET /api/v2/init-script/{os}/{arch}coderd/initscript.go:39-40GET /api/v2/init-script/{os}/{arch}400for an unsupported pair, and the match ignores casecoderd/initscript.go:29-37osandarchpath parameterslinux,darwin,windows, andamd64,arm64, plusarmv7onlinuxonlyprovisionersdk/agent.go:25-39GET /api/v2/init-script/{os}/{arch}init_scriptof acoder_agentfrom the same scriptprovisionersdk/agent.go:42-44(AgentScriptEnvis documented as consumed by the Coder Terraform provider, which performs additional substitutions)Writing rules applied
api.Authorizecalls, middleware, andcoderd/rbac/roles.go.Part of DOCS-1439.
Generated by Coder Agents on behalf of @nickvigilante.