docs: Clarify max-body-size applies to requests and responses#5186
Open
JoshVanL wants to merge 2 commits into
Open
docs: Clarify max-body-size applies to requests and responses#5186JoshVanL wants to merge 2 commits into
JoshVanL wants to merge 2 commits into
Conversation
docs: Clarify max-body-size applies to requests and responses Updated the max-body-size annotation description to clarify that it applies to: - Incoming HTTP/gRPC requests to the Dapr sidecar - Actor operation responses - Binding component responses (added in v1.16.2) This clarification helps users understand that the annotation controls both request and response body sizes, not just incoming requests. Signed-off-by: Junaid Khan <jukhan@cisco.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Clarifies the dapr.io/max-body-size annotation documentation to explicitly cover both HTTP/gRPC request bodies and response bodies (including actor operation responses and binding component responses), reducing user confusion about its scope.
Changes:
- Updated the
--max-body-size/dapr.io/max-body-sizeentry to describe applicability to both requests and responses. - Added a version note about when binding component response size enforcement was introduced.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | `--dapr-http-port` | `--dapr-http-port` | | not supported | HTTP port for the Dapr API to listen on (default `3500`) | | ||
| | `--dapr-http-max-request-size` | `--dapr-http-max-request-size` | | `dapr.io/http-max-request-size` | **Deprecated** in favor of `--max-body-size`. Inreasing the request max body size to handle large file uploads using http and grpc protocols. Default is `4` MB | | ||
| | `--max-body-size` | not supported | | `dapr.io/max-body-size` | Inreasing the request max body size to handle large file uploads using http and grpc protocols. Set the value using size units (e.g., `16Mi` for 16MB). The default is `4Mi` | | ||
| | `--max-body-size` | not supported | | `dapr.io/max-body-size` | Maximum size for HTTP/gRPC request and response bodies. Applies to incoming requests to the Dapr sidecar, actor operations, and binding component responses. Useful for handling large file uploads/downloads. Set the value using size units (e.g., `16Mi` for 16MB). The default is `4Mi`. Note: Binding component response size enforcement added in Dapr v1.16.3. | |
| | `--dapr-http-port` | `--dapr-http-port` | | not supported | HTTP port for the Dapr API to listen on (default `3500`) | | ||
| | `--dapr-http-max-request-size` | `--dapr-http-max-request-size` | | `dapr.io/http-max-request-size` | **Deprecated** in favor of `--max-body-size`. Inreasing the request max body size to handle large file uploads using http and grpc protocols. Default is `4` MB | | ||
| | `--max-body-size` | not supported | | `dapr.io/max-body-size` | Inreasing the request max body size to handle large file uploads using http and grpc protocols. Set the value using size units (e.g., `16Mi` for 16MB). The default is `4Mi` | | ||
| | `--max-body-size` | not supported | | `dapr.io/max-body-size` | Maximum size for HTTP/gRPC request and response bodies. Applies to incoming requests to the Dapr sidecar, actor operations, and binding component responses. Useful for handling large file uploads/downloads. Set the value using size units (e.g., `16Mi` for 16MB). The default is `4Mi`. Note: Binding component response size enforcement added in Dapr v1.16.3. | |
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.
Updated the max-body-size annotation description to clarify that it applies to:
This clarification helps users understand that the annotation controls both request and response body sizes, not just incoming requests.
Forward port of https://github.com/dapr/docs/pull/4935/commits