Repository navigation
docs: describe the PortSharing API operations and parameters - #31549
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 3
PortSharingroutes and improves 5 of their parameters.The 3
workspacepath parameters stay as "Workspace ID." because they accept only a UUID.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
share_levelauthenticated,organization, orpublic(owneris rejected);protocolhttporhttps; agent must exist in the latest buildcontrol_shared_portsfeature) the template'smax_port_share_levellimits allowed levels; without it any level is allowedworkspaceis a UUID onlydoc-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 port range, accepted levels and protocols, the Premium-only
max_port_share_levellimit, and the 404 on delete matchcoderd/workspaceagentportshare.goandenterprise/coderd/portsharing/portsharing.go.Continuity Editor: No findings.
The three
workspaceparameters share one wording.Copy Editor: No findings that block.
Two non-blocking suggestions are left as they are.
Skeptic: kept 0 and rejected 2.
One finding that the upsert permission sentence runs past 25 words, rejected because the style guide's sentence length is a target and the sentence needs the length to stay precise.
One finding that the request body text says "as described above", rejected as a judgment call with no cited rule, which never blocks.
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.