Repository navigation
docs(databases): state the Data API request body limit - #188
shawnwu-kong wants to merge 2 commits into
Conversation
Data API request bodies are capped at 4 MiB; a larger one is refused with 413. Point large files at Storage instead. Refs VOL-1423
AI review: no P0-P2 findingsDocs-only change. The Database REST API page now says Data API request bodies are capped at 4 MiB, that a larger body gets ⚪ P3
Not checked: The AI review read the diff, the code, and the PR's text; it ran no tests or builds and read nothing outside this repository.
Human review: not needed |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
|
||
| A request body can be up to 4 MiB. A larger one is refused with `413` and | ||
| `{"error": "request body too large"}`. Keep large files in | ||
| [Storage](/platform/storage/overview) and store their path in the row instead. |
There was a problem hiding this comment.
⚪ P3: Storage link uses a site-absolute path within the platform section
spec/writing.md says to link within a section by relative path with .md (its example is ../guides/deployment-source.md) and to use site-absolute paths only for links to another section. [Storage](/platform/storage/overview) is now the only /platform/... link anywhere under content/platform. Every other cross-directory link there, including interfaces/dashboard.md's link to the same page, uses the relative form. The link still resolves, so this is a convention issue only. Change it to [Storage](../storage/overview.md).
Found by claude-opus-5-5
| /databases/{databaseName}/branches/{branchName}/query/{operation}`. Everything on | ||
| this page applies unchanged. See [Branching](branching.md). | ||
|
|
||
| A request body can be up to 4 MiB. A larger one is refused with `413` and |
There was a problem hiding this comment.
⚪ P3: Body-size limit is outside the page's Limits section
The page already has a ## Limits section (around line 813) that lists per-request constraints such as the 60-second query time and connection capacity, plus an ## Error Handling section that lists error bodies. The new 4 MiB limit and its 413 response sit in the Overview instead, so a reader scanning Limits or Error Handling won't find them. Consider adding a Request body bullet under Limits next to Query time, and optionally a 413 entry under Error Handling.
Found by claude-opus-5-5
Volcano refuses a call-api request over 4 MiB with 413. State it next to each SDK's provider API call. Refs VOL-1423
|
|
||
| A request body can be up to 4 MiB. A larger one is refused with `413` and | ||
| `{"error": "request body too large"}`. Keep large files in | ||
| [Storage](/platform/storage/overview) and store their path in the row instead. |
There was a problem hiding this comment.
⚪ P3: Storage link does not follow the within-section linking convention
spec/writing.md requires relative .md links within a section. Use [Storage](../storage/overview.md) to follow the platform docs convention and preserve navigation in the GitHub-rendered source.
Found by gpt-6.1-sol
| /databases/{databaseName}/branches/{branchName}/query/{operation}`. Everything on | ||
| this page applies unchanged. See [Branching](branching.md). | ||
|
|
||
| A request body can be up to 4 MiB. A larger one is refused with `413` and |
There was a problem hiding this comment.
⚪ P3: Request-body limit is missing from the existing Limits section
The new limit appears only in Overview, so readers consulting ## Limits alongside the existing connection and query-time constraints will miss it. Consider adding a request-body bullet there.
Found by gpt-6.1-sol
Companion to Kong/volcano-hosting#3435 for VOL-1423, which caps Data API request bodies at 4 MiB. A larger body is refused with
413and{"error": "request body too large"}.This adds one paragraph to the Database REST API page, under the endpoint description, stating the limit and pointing large files at Storage. Insert takes a single row, so the limit only affects a row holding a very large value.
It also caps
call-api, the provider API proxy, at 4 MiB per request. The JS, Python and Ruby SDK authentication pages now state that limit next tocallOAuthAPI/call_oauth_api.Merge when the hosting change reaches production, not when it merges.
Validation:
pnpm lint:docs contentandpnpm check:linkspass.