Skip to content

docs(saas-api): name the X-CacheKit-* response headers CORS exposes (LAB-12286) - #226

Merged
27Bslash6 merged 1 commit into
mainfrom
lab-12286-cors-exposed-headers
Nov 1, 2026
Merged

27Bslash6 merged 1 commit into
mainfrom
lab-12286-cors-exposed-headers

Conversation

@27Bslash6

Copy link
Copy Markdown
Contributor

spec/saas-api.md said the deployed CORS policy "exposes no X-CacheKit-* response header". It exposes two, X-CacheKit-Limiter and X-CacheKit-Deny-Reason, beside Retry-After and the RateLimit-* headers. It does not expose the freshness headers, X-CacheKit-Freshness and X-CacheKit-Fresh-For.

The sentence now names what is exposed and what is not. Its conclusion is unchanged: freshness headers stay unreadable cross-origin, ck_sdk_ keys still cannot be used there, and no key class is intended for browser code.

@coderabbitai

coderabbitai Bot commented Nov 1, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review.

Recent review info
Run configuration
Commits

Reviewing files that changed from the base of the PR and between bd21cc9 and d6ed4b0.

Files selected for processing: 1
  • spec/saas-api.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

Summary by CodeRabbit

  • Documentation
    • Clarified which response headers are available to allowlisted cross-origin requests: X-CacheKit-Limiter and X-CacheKit-Deny-Reason. Freshness-related headers are not exposed.

Walkthrough

The CORS specification now states that allowlisted origins can read X-CacheKit-Limiter and X-CacheKit-Deny-Reason. It states that X-CacheKit-Freshness and X-CacheKit-Fresh-For are not exposed.

Changes

CORS Header Specification

Layer / File(s) Summary
CORS response header exposure
spec/saas-api.md
The specification names the two exposed response headers and states that the freshness headers are not exposed. It retains the restriction on X-CacheKit-* request headers and the resulting exclusion of ck_sdk_ keys from cross-origin use.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Merge Risk: Minimal · up to d6ed4

The PR only clarifies documented CORS response-header exposure; it is mergeable as reviewed.

Pre-merge checks: Passed 5
Check name Status Explanation
Title check Passed The title clearly and concisely identifies the documentation change to name the X-CacheKit response headers exposed by CORS.
Description check Passed The description directly explains the CORS documentation change and identifies both the exposed and unexposed response headers.
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

Finishing Touches
Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

@27Bslash6

Copy link
Copy Markdown
Contributor Author

@kody start-review

@27Bslash6
27Bslash6 merged commit 5644fb3 into main Nov 1, 2026
5 checks passed
@27Bslash6
27Bslash6 deleted the lab-12286-cors-exposed-headers branch November 1, 2026 06:38
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