docs: add note about large file multipart uploads #2025
Merged
Conversation
This file contains 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
The Multipart extractor is commonly used for file uploads, but it is not mentioned directly in the relevant documentation that these uploads are affected by the global request body limit. This commit adds a note in the Multipart documentation that links to DefaultBodyLimit.
davidpdrsn
reviewed
Jun 5, 2023
Co-authored-by: David Pedersen <[email protected]>
davidpdrsn
approved these changes
Jun 5, 2023
Merged
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.
Motivation
When using the Multipart extractor in a project, I quickly ran into the problem of my requests failing due to the upload size being too large. To find a solution I had to google around to find that the default body limit is set to 2MB. I think that mentioning this in the documentation for the Multipart extractor would be beneficial and provide some clarity for those not familiar with DefaultBodyLimit or aware that it even exists.
Solution
The Multipart extractor is commonly used for file uploads, but it is not mentioned directly in the relevant documentation that these uploads are affected by the global request body limit. This pull request adds a note in the Multipart documentation that links to DefaultBodyLimit.