Repository navigation
docs: describe the Notifications API operations and parameters - #31500
Closed
nickvigilante wants to merge 3 commits into
Closed
nickvigilante wants to merge 3 commits into
nickvigilante wants to merge 3 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 style guide prefers "turn off" over "disable" in product-facing prose. Part of DOCS-1439. Assisted-by: AI
The delivery methods route returns the methods Coder defines, not only the ones the deployment has configured, so the description no longer says it lists the methods the deployment supports. 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 13
Notificationsroutes and improves 14 of their parameters.The REST API reference renders these routes from
swagger.json, and they had no description.The inbox routes are for you, and the settings, templates, test, and dispatch routes are for administrators.
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
useraccepts ID, username, ormetemplate_disabled_map, template ID to disabled flagread_statusdefaultall; valuesall,read,unreadtargetsmust all match;starting_beforeunknown ID returns the first pagenotificationandunread_countformatdefaultmarkdown,plaintextconverts title and content; filterstargets(all must match),templates,read_status(defaultall)is_read; returns notification andunread_countdoc-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 wrong claim: the delivery methods route said it lists the methods the deployment supports, but it returns every method Coder defines except inbox (
coderd/notifications.go:177-194).Fixed in a follow-up commit.
Continuity Editor: No findings.
Shared
userwording matches the handler (httpmw.ExtractUserParam), and the Owner-role sentences use the same form on every route.Copy Editor: No findings after the fix above.
The "disable" wording was already changed to "turn off" in the first follow-up commit.
Skeptic: kept 1 and rejected 2.
One nbsp-between-number-and-unit finding for "2000 bytes", rejected because
Coder.UnitSpacingskips pages generated from Go source (word-choiceandnumbers-units-and-datesrule text).One finding that "Use the query parameters to filter which notifications you receive" is redundant, rejected because no style rule cites it.
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.