Skip to content

docs: document ACL API, RedisURI auth/config, HyperLogLog & hash field-expiration#1149

Merged
yisraelU merged 2 commits into
profunktor:series/2.xfrom
yisraelU:docs/acl-and-uri-auth
Jun 22, 2026
Merged

docs: document ACL API, RedisURI auth/config, HyperLogLog & hash field-expiration#1149
yisraelU merged 2 commits into
profunktor:series/2.xfrom
yisraelU:docs/acl-and-uri-auth

Conversation

@yisraelU

Copy link
Copy Markdown
Collaborator

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

  • New site/docs/effects/acl.md covering the AclCommands algebra: usage, the typed SETUSER rules (AclSetUserRule / AclCategory / RawCommand) with a rule → ACL SETUSER mapping table, the AclUser/AclSelector GETUSER result and its Option/absence semantics, ACL CAT, the ACL log, and AclError (UnknownCommand / DecodingFailure) + the string-codec note.
  • Listed in the effects API index.

RedisURI authentication & config

  • Reworked the Client page's authentication section to make the URI-config ↔ auth relationship explicit: the three ways to supply credentials, the RedisCredentials sum type (Password vs UsernameAndPassword = ACL user), how RedisUriConfig.withCredentials ties in, sentinel per-node passwords, and connection-time vs runtime (Connection API auth) authentication — cross-linked to the ACL page.

Other gaps closed

  • New site/docs/effects/hyperloglog.md (PFADD/PFCOUNT/PFMERGE) + index entry — the algebra previously had no page.
  • Documented 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.

Verification

  • sbt microsite/mdoc0 errors; all new scala mdoc blocks type-check against the effects module.
  • Remaining mdoc warnings are the repo's pre-existing .html-link / unused-binder style warnings, uniform with every existing doc.

🤖 Generated with Claude Code

yisraelU and others added 2 commits June 22, 2026 12:34
- 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>
@yisraelU yisraelU merged commit 0f537c9 into profunktor:series/2.x Jun 22, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant