Skip to content

docs(saas-api): keep max-value note to client-facing contract only#15

Merged
27Bslash6 merged 1 commit into
mainfrom
security/saas-api-drop-internals
Jun 15, 2026
Merged

docs(saas-api): keep max-value note to client-facing contract only#15
27Bslash6 merged 1 commit into
mainfrom
security/saas-api-drop-internals

Conversation

@27Bslash6

@27Bslash6 27Bslash6 commented Jun 15, 2026

Copy link
Copy Markdown
Contributor

Follow-up to #14 (merged). The "Maximum value size" note added there included backend storage-implementation detail; this trims it to the client-facing API contract only.

Keeps: max value size (25 MB) → permanent 413; SDKs treat any 413 as "value too large"; the ceiling MAY change; unrelated to the 512 MB serializer bound.

Docs-only.

Summary by CodeRabbit

  • Documentation
    • Updated cache API specification to clarify maximum value size limits and error handling. Values exceeding 25 MB are now documented as being rejected with 413 Payload Too Large error responses. All 413 errors should be interpreted as indicating the submitted value is too large.

@coderabbitai

coderabbitai Bot commented Jun 15, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 536849e7-6664-466a-a686-309b16e49a50

📥 Commits

Reviewing files that changed from the base of the PR and between cb6917c and 14fa495.

📒 Files selected for processing (1)
  • spec/saas-api.md

Walkthrough

The "Maximum value size" note for PUT /v1/cache/{key} in spec/saas-api.md is reworded on a single line: the explanation of internal chunking and the server-side ceiling vs. storage-cell distinction is removed, while the 25 MB limit, 413 Payload Too Large permanent-error behaviour, and treat-any-413-as-value-too-large guidance are retained.

Changes

SaaS API Specification

Layer / File(s) Summary
Reword maximum value size note
spec/saas-api.md
Removes the internal chunking and server-side ceiling vs. storage-cell explanation from the 25 MB note, keeping the 413 permanent-error and treat-any-413-as-value-too-large guidance.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • cachekit-io/protocol#14: Also modifies spec/saas-api.md to document the PUT /v1/cache/{key} 25 MB maximum value size and 413 Payload Too Large as a permanent "value too large" error — directly overlapping content with this PR.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the main change: removing backend implementation details from documentation whilst maintaining client-facing API contract specifications.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch security/saas-api-drop-internals

Comment @coderabbitai help to get the list of available commands and usage tips.

@27Bslash6 27Bslash6 merged commit 72e8c73 into main Jun 15, 2026
1 check passed
@27Bslash6 27Bslash6 deleted the security/saas-api-drop-internals branch June 15, 2026 08:53
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