Document cache key format and TTL precedence rules - #413
Merged
Lakes41 merged 1 commit intoJul 28, 2026
Merged
Conversation
Contributor
|
This PR cannot be merged automatically because it has merge conflicts. Please update the branch with the latest base branch and resolve the conflicts. After the conflicts are resolved and checks pass, the automation can review it again. |
- Add Key Composition subsection listing exact key templates per service method - Add TTL Precedence subsection with worked example - Fix inaccurate per-call TTL override claim in existing docs - Add cross-links from sdk-guide.md and architecture.md Closes Adamantine-guild#392
Joyful12-tech
force-pushed
the
docs/cache-key-format-and-ttl-precedence
branch
from
July 28, 2026 11:35
1c1e3ab to
75ae166
Compare
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.
Summary
This PR adds documentation for exact cache key formats and TTL precedence rules, as requested in #392.
Changes
docs/cache-adapters.md
checkAccess,checkRoleAccess,getMembership,getRoles,getUserRoles,getGuild,getGuildConfig), verified against the actual source insrc/client/GuildPassClient.ts.cacheTtlapplies, with a concrete worked example.withCachealways passesthis.cacheTtl). The text now accurately reflects the source.wallet:prefix is an invalidation-only namespace.docs/sdk-guide.md
docs/architecture.md
Discrepancy noted
The issue's acceptance criteria asked for a worked example with a per-call TTL override. No such override exists in the current implementation —
RequestOptionscarriestimeoutMs,retry, andsignalbut nocacheTtlfield, andwithCache()always uses the client-levelcacheTtl. The documentation reflects this accurately rather than inventing a feature.Closes #392