Repository navigation
docs: describe the Secrets API operations and parameters - #31545
Closed
nickvigilante wants to merge 2 commits into
Closed
nickvigilante wants to merge 2 commits into
nickvigilante wants to merge 2 commits into
Conversation
The REST API reference renders these routes from swagger.json, and they had no description. Part of DOCS-1439. Assisted-by: AI
The create description now states the 24 KiB cap on secrets that set an env_name, which binds before the 200 KiB total. 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 6
Secretsroutes and improves 12 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
ResourceUserSecret), coderd/rbac/roles.go:601 (Organization Admin excludes it), coderd/rbac/roles.go:458-459 (Member keeps it for own resources), coderd/database/dbauthz/dbauthz.go:7444-7450valueup to 24 KiB;nameandvaluerequired;enableddefaults totrueenv_name,file_path, or both, and needs one of themenv,json,yaml; content up to 1 MiB; up to 50 entriesenv_nameenv_nameorfile_pathuseraccepts ID, username, ormeenv_nametotal at most 24 KiB per userdoc-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: Found one incomplete limit: the create description gave the 200 KiB total but not the 24 KiB cap on secrets that set an
env_name, which the database trigger enforces first (coderd/database/migrations/000509_user_secrets_limits.up.sql:55-100).Fixed in a follow-up commit.
Continuity Editor: No findings.
The
userwording matches the shared text and the handlers usehttpmw.ExtractUserParam.Copy Editor: No findings.
The "disabled" wording was reworded before the first push.
Skeptic: kept 1 and rejected 2.
One nbsp finding for "24 KiB" and "1 MiB", rejected because
Coder.UnitSpacingskips pages generated from Go source.One claim that the 24 KiB value limit is wrong for encrypted deployments, rejected because the API validates plaintext length against that constant (
codersdk/usersecretvalidation.go:346-353) and the description states the API limit.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.