docs(saas-api): document 25MB max value size and 413 response#14
Merged
Conversation
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).
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (1)
WalkthroughThe SaaS API spec adds a 25 MB maximum cache value size constraint, with Changes413 Payload Too Large — 25 MB value size limit
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents the maximum cache value size and the
413response inspec/saas-api.md:/v1/cache/{key}: max value size 25 MB →413 Payload Too Large(permanent; SDKs MUST NOT retry, surface "value too large"). The ceiling MAY change, so SDKs treat any413as value-too-large. Unrelated to the SDK serializer's 512 MB in-memory bound.413to the HTTP status-code table and the Permanent error class.Docs-only; client-facing API contract.