Skip to content

docs: Clarify that maxUploadSize limits the request body size, not the file size #10557

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dblythy wants to merge 1 commit into
base: alpha
Choose a base branch
from
+3 −3
Open

docs: Clarify that maxUploadSize limits the request body size, not the file size #10557

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/Options/Definitions.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -416,7 +416,7 @@ module.exports.ParseServerOptions = {
},
maxUploadSize: {
env: 'PARSE_SERVER_MAX_UPLOAD_SIZE',
help: 'Max file size for uploads, defaults to 20mb',
help: 'The maximum size of the HTTP request body for file uploads, for example `20mb`. This limits the request body size, not the file size: the encoded upload is larger than the file itself, so set this higher than your largest intended file to allow for encoding overhead. Files sent as base64 (for example via the JavaScript SDK) inflate the payload by roughly 33%, and multipart uploads add boundary and header overhead. Defaults to `20mb`.',
default: '20mb',
},
middleware: {
Expand Down
2 changes: 1 addition & 1 deletion src/Options/docs.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion src/Options/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ export interface ParseServerOptions {
:ENV: PARSE_SERVER_ENABLE_INSECURE_AUTH_ADAPTERS
:DEFAULT: false */
enableInsecureAuthAdapters: ?boolean;
/* Max file size for uploads, defaults to 20mb
/* The maximum size of the HTTP request body for file uploads, for example `20mb`. This limits the request body size, not the file size: the encoded upload is larger than the file itself, so set this higher than your largest intended file to allow for encoding overhead. Files sent as base64 (for example via the JavaScript SDK) inflate the payload by roughly 33%, and multipart uploads add boundary and header overhead. Defaults to `20mb`.
:DEFAULT: 20mb */
maxUploadSize: ?string;
Comment on lines +211 to 213

@coderabbitai coderabbitai Bot Jul 26, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Document that the limit also applies to non-multipart JSON requests.

The runtime passes maxUploadSize to the global express.json parser for non-multipart requests, so this description is narrower than the actual behavior. Users may assume large JSON requests are unaffected when they are also subject to this limit.

  • src/Options/index.js#L211-L213: clarify the source text to cover non-multipart JSON request bodies.
  • src/Options/Definitions.js#L419: regenerate this description from the corrected source.
  • src/Options/docs.js#L81: regenerate this documentation from the corrected source.
🧰 Tools
🪛 Biome (2.5.3)

[error] 213-213: Expected a statement but instead found '?'.

(parse)

📍 Affects 3 files
  • src/Options/index.js#L211-L213 (this comment)
  • src/Options/Definitions.js#L419-L419
  • src/Options/docs.js#L81-L81
🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@src/Options/index.js` around lines 211 - 213, The maxUploadSize description
should state that the limit applies to non-multipart JSON request bodies as well
as file uploads. Update the source description in src/Options/index.js:211-213,
then regenerate the corresponding descriptions in src/Options/Definitions.js:419
and src/Options/docs.js:81 from that corrected source.

/* Set to `true` to require users to verify their email address to complete the sign-up process. Supports a function with a return value of `true` or `false` for conditional verification. The function receives a request object that includes `createdWith` to indicate whether the invocation is for `signup` or `login` and the used auth provider.
Expand Down
Loading