docs: document ACL API, RedisURI auth/config, HyperLogLog & hash field-expiration#1149
Merged
Merged
Conversation
- Add site/docs/effects/acl.md covering the AclCommands algebra: typed SETUSER rules (AclSetUserRule / AclCategory / RawCommand), the AclUser / AclSelector GETUSER result and its Option semantics, ACL CAT / LOG, and AclError (UnknownCommand / DecodingFailure) plus the string-codec note. - List the ACL API in the effects index. - Expand the Client page's authentication section: the three ways to supply credentials, the RedisCredentials sum type (Password vs UsernameAndPassword = ACL user), how RedisUriConfig.withCredentials relates to it, sentinel per-node passwords, and connection-time vs runtime (Connection API `auth`) auth, with cross-links to the ACL page. Verified with `microsite/mdoc` (0 errors). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
- Add site/docs/effects/hyperloglog.md (PFADD/PFCOUNT/PFMERGE) and list it in the effects index. - Document the Redis 7.4+ per-field expiration and read-and-modify hash commands in hashes.md: hExpire/hExpireAt (+ ExpireExistenceArg), httl/hpttl, hExpireTime/hpExpireTime, hPersist, hGetEx (HGetExArgs) and hGetDel. Verified with `microsite/mdoc` (0 errors). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
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.
What
Documentation-only follow-up to the recently merged ACL (#1144) and
RedisUriConfig(#1143) work, plus a sweep that closed two adjacent gaps found along the way.ACL
site/docs/effects/acl.mdcovering theAclCommandsalgebra: usage, the typedSETUSERrules (AclSetUserRule/AclCategory/RawCommand) with a rule →ACL SETUSERmapping table, theAclUser/AclSelectorGETUSERresult and itsOption/absence semantics,ACL CAT, the ACL log, andAclError(UnknownCommand/DecodingFailure) + the string-codec note.RedisURI authentication & config
RedisCredentialssum type (PasswordvsUsernameAndPassword= ACL user), howRedisUriConfig.withCredentialsties in, sentinel per-node passwords, and connection-time vs runtime (Connection APIauth) authentication — cross-linked to the ACL page.Other gaps closed
site/docs/effects/hyperloglog.md(PFADD/PFCOUNT/PFMERGE) + index entry — the algebra previously had no page.hashes.md:hExpire/hExpireAt(+ExpireExistenceArg),httl/hpttl,hExpireTime/hpExpireTime,hPersist,hGetEx(HGetExArgs) andhGetDel.Verification
sbt microsite/mdoc— 0 errors; all newscala mdocblocks type-check against the effects module.mdocwarnings are the repo's pre-existing.html-link / unused-binder style warnings, uniform with every existing doc.🤖 Generated with Claude Code