Skip to content

feat: update documentation for response min size compression #124

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

Merged
jensneuse merged 3 commits into from
Jul 25, 2025
Merged

feat: update documentation for response min size compression #124

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
faa8d9e
feat: update documentation for response min size compression
Jul 17, 2025
8b81310
fix: made kb to kib to reflect correct value in router
SkArchon Jul 25, 2025
090c781
fix: review comments
SkArchon Jul 25, 2025
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
14 changes: 8 additions & 6 deletions docs/router/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1181,6 +1181,7 @@ traffic_shaping:
max_request_body_size: 5MB
max_header_bytes: 1MiB
decompression_enabled: true
response_compression_min_size: 4KiB
all: # Rules are applied to all subgraph requests.
# Subgraphs transport options
request_timeout: 60s
Expand Down Expand Up @@ -1296,12 +1297,13 @@ Configure circuit breaker either for all subgraphs, or per subgraph. More inform

These rules apply to requests being made from clients to the Router.

| Environment Variable | YAML | Required | Description | Default Value |
| -------------------- | --------------------- | ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| | max_request_body_size | <Icon icon="square" /> | | 5mb |
| MAX_HEADER_BYTES | max_header_bytes | <Icon icon="square" /> | Minimum Router version: [0.156.0](https://github.com/wundergraph/cosmo/compare/router@0.155.0...router@0.156.0) The maximum size of the request headers. Setting this to 0 uses the default value from the http standard lib, which is 1MiB. | 1mib |
| | decompression_enabled | <Icon icon="square" /> | When enabled, the router will check incoming requests for a 'Content-Encoding' header and decompress the body accordingly Note: Currently only "gzip" is supported | true |
| 5mb | | | | |
| Environment Variable | YAML | Required | Description | Default Value |
| -------------------- | ----------------------------- | ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| | max_request_body_size | <Icon icon="square" /> | | 5mb |
| MAX_HEADER_BYTES | max_header_bytes | <Icon icon="square" /> | Minimum Router version: [0.156.0](https://github.com/wundergraph/cosmo/compare/router@0.155.0...router@0.156.0) The maximum size of the request headers. Setting this to 0 uses the default value from the http standard lib, which is 1MiB. | 1mib |
| | decompression_enabled | <Icon icon="square" /> | When enabled, the router will check incoming requests for a 'Content-Encoding' header and decompress the body accordingly Note: Currently only "gzip" is supported | true |
| | response_compression_min_size | <Icon icon="square" /> | The minimum size of the response body in bytes to enable response compression. The size is specified as a string with a number and a unit, e.g. 10KB, 1MB, 1GB | 4KiB |
| 5mb | | | | |

## WebSocket

Expand Down