Skip to content

docs(dig-node): reconcile the two cache-method families in the control contract - #6

Merged
MichaelTaylor3d merged 1 commit into
mainfrom
docs/control-cache-family-reconciliation
Jul 6, 2026
Merged

docs(dig-node): reconcile the two cache-method families in the control contract#6
MichaelTaylor3d merged 1 commit into
mainfrom
docs/control-cache-family-reconciliation

Conversation

@MichaelTaylor3d

Copy link
Copy Markdown
Contributor

What

Follow-up to #5 (the #130 canonical control contract). Adds SPEC §7.9 reconciling the two cache-method families the node exposes, per the cross-repo consistency audit.

Why

The audit flagged that dig-node exposes TWO cache families — the open cache.* (getConfig/setCapBytes/…) and the token-gated control.cache.* (get/setCap/clear) — with no explicit reconciliation in the canonical control-interface doc. This documents the dual surface so consumers know which to use.

Changes (docs-only)

  • SPEC §7.9 documents both families, the exact name mapping (control.cache.getcache.getConfig, control.cache.setCapcache.setCapBytes, control.cache.clearcache.clear), that both are permanent/backwards-compatible (neither renamed), consumer guidance (token holder → control.cache.*; sandboxed/FFI consumer → cache.*), and that the SPEC's full catalogue is authoritative (consumers implement subsets without diverging names; dig-rpc-types is the eventual shared home).

Version

0.5.0 → 0.5.1 (patch, docs-only; no code/API/behavior change).

Verified

Docs + version only; no Rust source touched. CI gates (fmt/clippy/test/coverage/build) run on the workspace unchanged from the green #5 merge.

Refs #130.

…l contract
Add SPEC §7.9 documenting that the node exposes cache operations under TWO method
families by design: the OPEN node-engine-native `cache.*` (getConfig/setCapBytes/
clear/listCached/removeCached/fetchAndCache — no token, also the in-process FFI
names the DIG Browser chrome://settings handler calls) and the token-gated
`control.cache.*` operator aliases (get/setCap/clear). Records the name mapping
(control.cache.get↔cache.getConfig, setCap↔setCapBytes, clear↔clear), states both
are permanent/backwards-compatible (neither renamed), and gives consumer guidance
(token holder → control.cache.*; sandboxed/FFI consumer → cache.*). Also states the
full catalogue defined by this SPEC is authoritative, consumers implement subsets
without diverging names, and dig-rpc-types is the eventual shared home.
Closes the #130 naming-reconciliation gap flagged in the cross-repo consistency
audit (three hand-mirrored control lists + two cache families). Docs-only.
@MichaelTaylor3d
MichaelTaylor3d merged commit 1ada8f1 into mainJul 6, 2026
9 checks passed
@MichaelTaylor3d
MichaelTaylor3d deleted the docs/control-cache-family-reconciliation branch July 6, 2026 17:38
MichaelTaylor3d added a commit that referenced this pull request Jul 10, 2026
…l contract (#6)
Add SPEC §7.9 documenting that the node exposes cache operations under TWO method
families by design: the OPEN node-engine-native `cache.*` (getConfig/setCapBytes/
clear/listCached/removeCached/fetchAndCache — no token, also the in-process FFI
names the DIG Browser chrome://settings handler calls) and the token-gated
`control.cache.*` operator aliases (get/setCap/clear). Records the name mapping
(control.cache.get↔cache.getConfig, setCap↔setCapBytes, clear↔clear), states both
are permanent/backwards-compatible (neither renamed), and gives consumer guidance
(token holder → control.cache.*; sandboxed/FFI consumer → cache.*). Also states the
full catalogue defined by this SPEC is authoritative, consumers implement subsets
without diverging names, and dig-rpc-types is the eventual shared home.
Closes the #130 naming-reconciliation gap flagged in the cross-repo consistency
audit (three hand-mirrored control lists + two cache families). Docs-only.
Co-Authored-By: Claude <noreply@anthropic.com>
MichaelTaylor3d added a commit that referenced this pull request Jul 10, 2026
…l contract (#6)
Add SPEC §7.9 documenting that the node exposes cache operations under TWO method
families by design: the OPEN node-engine-native `cache.*` (getConfig/setCapBytes/
clear/listCached/removeCached/fetchAndCache — no token, also the in-process FFI
names the DIG Browser chrome://settings handler calls) and the token-gated
`control.cache.*` operator aliases (get/setCap/clear). Records the name mapping
(control.cache.get↔cache.getConfig, setCap↔setCapBytes, clear↔clear), states both
are permanent/backwards-compatible (neither renamed), and gives consumer guidance
(token holder → control.cache.*; sandboxed/FFI consumer → cache.*). Also states the
full catalogue defined by this SPEC is authoritative, consumers implement subsets
without diverging names, and dig-rpc-types is the eventual shared home.
Closes the #130 naming-reconciliation gap flagged in the cross-repo consistency
audit (three hand-mirrored control lists + two cache families). Docs-only.
Co-Authored-By: Claude <noreply@anthropic.com>
Sign up for freeto 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

@MichaelTaylor3d