Skip to content

docs: Document per-principal cache namespacing and scope headers#1656

Merged
lukekim merged 2 commits into
trunkfrom
docs/update-from-pr-10702
May 6, 2026
Merged

docs: Document per-principal cache namespacing and scope headers#1656
lukekim merged 2 commits into
trunkfrom
docs/update-from-pr-10702

Conversation

@claudespice
Copy link
Copy Markdown
Collaborator

Summary

  • Document per-principal cache isolation behavior when authentication is enabled
  • Document new Results-Cache-Scope and Search-Results-Cache-Scope response headers
  • Add breaking change warning for caching accelerator storage migration

Source PRs

Changes

  • website/docs/features/caching/index.md:
    • Added "Per-Principal Cache Isolation" section with namespace table and breaking change warning
    • Updated "Cached Responses" section to document the new scope headers alongside existing status headers
    • Updated response examples to include the results-cache-scope header

Test plan

  • Verified scope header values match the source implementation (shared, user, system)
  • Breaking change warning is prominent
  • Only vNext docs updated (feature is new)

When authentication is enabled, all cache layers are now automatically
scoped per principal. Documents the new Results-Cache-Scope and
Search-Results-Cache-Scope response headers, the Vary: Authorization
behavior, and the breaking change requiring caching accelerator storage
migration.

Source: spiceai/spiceai#10702
@claudespice claudespice self-assigned this May 6, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 6, 2026

✅ Pull with Spice Passed

Passing checks:

  • ✅ Title meets minimum length requirement (10 characters)
  • ✅ Has at least one of the required labels: area/blog, area/docs, area/cookbook, dependencies
  • ✅ No banned labels detected
  • ✅ Has at least one assignee: claudespice

The auth documentation is at api/auth, not ../auth.
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 6, 2026

🚀 deployed to https://0c7a40f9.spiceai-org-website.pages.dev

@lukekim lukekim merged commit e80dc96 into trunk May 6, 2026
6 checks passed
@lukekim lukekim deleted the docs/update-from-pr-10702 branch May 6, 2026 16:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants