Repository navigation
docs: describe the Audit API operations and parameters - #31552
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 limit parameter said the default of 0 returns all results, but the query returns 100 results when limit is 0. 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 a description for
GET /api/v2/auditand improves itsq,limit, andoffsetparameters.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
RequireFeatureMWand the handler checks no entitlementqkeys, bare term asresource_type, lowercased,date_toinclusive through end of day,username:me,organizationID or namelimitdefault 0 returns 100 results;offsetdefault 0doc-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
limitparameter said the default,0, returns all results, but the query returns 100 results whenlimitis 0 (coderd/database/queries/auditlogs.sql:109-112).Fixed in a follow-up commit.
Continuity Editor: No findings.
The
qkeys matchcoderd/searchquery/search.go:38-89.Copy Editor: No findings after the fix above.
Skeptic: kept 1 and rejected 2.
One finding that
limitis marked required but has a default, rejected because the required flag is an annotation bug outside this PR's scope.One finding that the Premium sentence should say the route requires a license, rejected because the code gates only recording (
enterprise/coderd/coderd.go:1031-1036), and the sentence says that.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.CI flakes unrelated to this change
test-go-pg (ubuntu-latest)failed two tests that this PR doesn't touch: https://github.com/coder/coder/actions/runs/40935636968/job/123665502865TestChatTurnStopsAtStepLimit/Defaultincoderd/x/chatd.TestServerTailnet_ReverseProxy_TCPDialFailureincoderd, a tailnet timing test that hit a 502 after about five seconds. This PR changes only annotation comments.Part of DOCS-1439.
Generated by Coder Agents on behalf of @nickvigilante.