You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
Updated documentation note under proxy_default_timeout to clarify that only http_server_options.write_timeout needs to be adjusted when proxy_default_timeout exceeds 120 seconds
Changes Made
Based on team feedback:
read_timeout is for the client sending a request TO Tyk - not dependent on upstream timeout
write_timeout is for Tyk writing the response BACK to the client - must be adjusted when upstream timeout increases
Test plan
Verify the note renders correctly in the documentation
Confirm internal links to read_timeout and write_timeout sections work
…imeout
When setting proxy_default_timeout to a value greater than 120 seconds,
the http_server_options.read_timeout and http_server_options.write_timeout
settings must also be increased accordingly, as they default to 120 seconds.
Resolves DX-1962
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <[email protected]>
Verify that the fragment identifiers used in the links to http_server_options.read_timeout and http_server_options.write_timeout match the actual generated IDs in the rendered docs; MDX/markdown heading-to-id rules may differ (underscores vs hyphens, case, dots).
<Note>
If you set `proxy_default_timeout` to a value greater than 120 seconds, you must also increase the [http_server_options.read_timeout](#http_server_optionsread_timeout) and [http_server_options.write_timeout](#http_server_optionswrite_timeout) settings to match or exceed this value. These settings default to 120 seconds, so if they are not adjusted, they will terminate the connection before the upstream timeout is reached.
</Note>
Consider clarifying whether the read/write timeouts must “match or exceed the upstream timeout” or simply be “greater than or equal to proxy_default_timeout,” and whether both must be raised or only the limiting one, to prevent confusion.
<Note>
If you set `proxy_default_timeout` to a value greater than 120 seconds, you must also increase the [http_server_options.read_timeout](#http_server_optionsread_timeout) and [http_server_options.write_timeout](#http_server_optionswrite_timeout) settings to match or exceed this value. These settings default to 120 seconds, so if they are not adjusted, they will terminate the connection before the upstream timeout is reached.
</Note>
The in-page anchors #http_server_optionsread_timeout and #http_server_optionswrite_timeout may not resolve if section IDs include dots or different casing. Update links to the exact, working anchors or use full paths to prevent broken navigation.
<Note>
-If you set `proxy_default_timeout` to a value greater than 120 seconds, you must also increase the [http_server_options.read_timeout](#http_server_optionsread_timeout) and [http_server_options.write_timeout](#http_server_optionswrite_timeout) settings to match or exceed this value. These settings default to 120 seconds, so if they are not adjusted, they will terminate the connection before the upstream timeout is reached.+If you set `proxy_default_timeout` to a value greater than 120 seconds, you must also increase the [http_server_options.read_timeout](#http_server_options-read_timeout) and [http_server_options.write_timeout](#http_server_options-write_timeout) settings to match or exceed this value. These settings default to 120 seconds, so if they are not adjusted, they will terminate the connection before the upstream timeout is reached.
</Note>
Suggestion importance[1-10]: 6
__
Why: The suggestion correctly targets the newly added Note block and proposes adding hyphens in the anchor IDs, which can fix common MDX/Markdown slug generation issues; however, without full context of the actual heading IDs, this is a cautious improvement rather than a guaranteed fix.
Updated the note under proxy_default_timeout to clarify that only
http_server_options.write_timeout needs to be adjusted when setting
proxy_default_timeout beyond 120 seconds.
The read_timeout setting is for client-to-Tyk request reading and is
independent of upstream timeouts. Only write_timeout affects the
response delivery to the client and must be adjusted accordingly.
Addresses feedback on DX-1962.
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <[email protected]>
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.
Summary
proxy_default_timeoutto clarify that onlyhttp_server_options.write_timeoutneeds to be adjusted whenproxy_default_timeoutexceeds 120 secondsChanges Made
Based on team feedback:
read_timeoutis for the client sending a request TO Tyk - not dependent on upstream timeoutwrite_timeoutis for Tyk writing the response BACK to the client - must be adjusted when upstream timeout increasesTest plan
read_timeoutandwrite_timeoutsections workResolves DX-1962
🤖 Generated with Claude Code