Repository navigation
docs(core): document audit-log filter behaviour per backend - #97
Open
lakhansamani wants to merge 1 commit into
Open
lakhansamani wants to merge 1 commit into
lakhansamani wants to merge 1 commit into
Conversation
The _audit_logs reference already listed all six filters while two backends silently ignored four of them. Records that they now apply everywhere, what upgraders should expect, and the index-backfill caveats on cassandra/scylla and couchbase. Operator-facing behaviour belongs in these sections, not in a spec.
✅ Deploy Preview for authorizerdev-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This branch was successfully deployed
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Operator-facing consequences of authorizerdev/authorizer#802 belong in the docs sections, not in a design spec. This puts them where a reader will actually find them.
Why
docs/core/graphql-api.mdalready documented all six_audit_logsfilters — while CassandraDB/ScyllaDB and Couchbase silently applied only two of them. The reference was correct about the intent and wrong about the behaviour, with nothing telling the reader which.Changes
docs/core/graphql-api.md— in the_audit_logssection: filters combine with AND and are applied by every backend; a callout for upgraders explaining that on those two backends four filters were previously accepted and ignored (and that any two filters at once failed outright on Cassandra/Scylla), so result counts andpagination.totalwill drop after upgrade. Stated explicitly as a correction rather than data loss, because that is how it will look otherwise.docs/core/databases.md— two> Note for …callouts in the existing per-backend style:nodetool viewbuildstatus, expect elevated I/O. Timestamp-range filters cannot use an index and perform anALLOW FILTERINGscan.Deliberately not documented
AdminAuthMode/ theauth_modeaudit field from authorizerdev/authorizer#806. That PR ships the plumbing and emits no audit records, so documenting the field now would describe behaviour that does not exist. It lands with the phase that writes it.Notes
No version number is asserted — the next release is not cut yet, so the upgrade callout references the PR and points at the changelog instead of guessing
2.4.2.npx docusaurus buildexits 0 with no broken links.Release notes proper are in authorizerdev/authorizer's
CHANGELOG.mdunder[Unreleased].