Skip to content

docs(saas-api): document 25MB max value size and 413 response#14

Merged
27Bslash6 merged 1 commit into
mainfrom
docs/saas-api-413-max-value
Jun 15, 2026
Merged

docs(saas-api): document 25MB max value size and 413 response#14
27Bslash6 merged 1 commit into
mainfrom
docs/saas-api-413-max-value

Conversation

@27Bslash6

@27Bslash6 27Bslash6 commented Jun 15, 2026

Copy link
Copy Markdown
Contributor

Documents the maximum cache value size and the 413 response in spec/saas-api.md:

  • PUT /v1/cache/{key}: max value size 25 MB413 Payload Too Large (permanent; SDKs MUST NOT retry, surface "value too large"). The ceiling MAY change, so SDKs treat any 413 as value-too-large. Unrelated to the SDK serializer's 512 MB in-memory bound.
  • Adds 413 to the HTTP status-code table and the Permanent error class.

Docs-only; client-facing API contract.

The SaaS rejects values over its maximum (25 MB) with 413 Payload Too Large,
a permanent error. Document the ceiling on PUT, add 413 to the status-code
table, and classify it under Permanent (do not retry) so SDKs surface it as
"value too large" rather than retrying. Notes that the backend chunks values
internally, so this is a server-side ceiling (not the storage cell limit) and
is distinct from the SDK serializer's 512 MB in-memory bound.

Companion to cachekit-io/saas (server-side value chunking + the 413 ceiling).
@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: 7763cded-6341-4063-97d3-a23ecc166da3

📥 Commits

Reviewing files that changed from the base of the PR and between 30ce996 and 990d584.

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

Walkthrough

The SaaS API spec adds a 25 MB maximum cache value size constraint, with 413 Payload Too Large defined as a permanent, non-retryable error. The 413 status is added to the cache PUT status table, the general HTTP error handling table, and the permanent-error classification table.

Changes

413 Payload Too Large — 25 MB value size limit

Layer / File(s) Summary
413 permanent error and 25 MB value size constraint
spec/saas-api.md
Adds the 25 MB maximum stored value size rule with 413 Payload Too Large as a permanent non-retryable error in the protocol constraint block and cache PUT status table; adds 413 to the general HTTP status table and the permanent-error classification row.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 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 PR title clearly and specifically summarises the main change: documenting a 25MB maximum value size limit and the corresponding 413 response for the SaaS API.
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 docs/saas-api-413-max-value

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

@27Bslash6 27Bslash6 merged commit cb6917c into main Jun 15, 2026
1 check passed
@27Bslash6 27Bslash6 deleted the docs/saas-api-413-max-value branch June 15, 2026 08:09
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