Skip to content

docs(boxsdkgen): add documentation about default timeout (box/box-codegen#944) #1401

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
box-sdk-build wants to merge 3 commits into
base: combined-sdk
Choose a base branch
from
+2 −2
Open

docs(boxsdkgen): add documentation about default timeout (box/box-codegen#944) #1401

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5051718
chore: Update `.codegen.json` with commit hash of `codegen` and `open…
box-sdk-build Apr 22, 2026
7f5558a
chore: Update `.codegen.json` with commit hash of `codegen` and `open…
box-sdk-build Apr 24, 2026
8298986
docs: add documentation about default timeout (box/box-codegen#944)
box-sdk-build Apr 28, 2026
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 .codegen.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{ "engineHash": "450fb53", "specHash": "d0976fc", "version": "4.7.0" }
{ "engineHash": "18868e7", "specHash": "d0976fc", "version": "4.7.0" }
2 changes: 1 addition & 1 deletion docs/box_sdk_gen/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ client = BoxClient(auth=auth, network_session=network_session)
How timeout handling works:

- Timeout values are configured in milliseconds and converted to seconds internally for HTTP requests.
- The SDK uses default timeouts when timeout config is not provided: `connection_timeout_ms=5000` and `read_timeout_ms=60000`.
- If timeout config is not provided, the SDK uses default timeouts: `connection_timeout_ms=5000` (5 seconds) and `read_timeout_ms=60000` (60 seconds).
- To disable all SDK timeouts, pass `TimeoutConfig(connection_timeout_ms=None, read_timeout_ms=None)` explicitly to `NetworkSession`.
- You can also disable only one timeout by setting one value to `None` (for example, `connection_timeout_ms=None` or `read_timeout_ms=None`). If you provide only the other value (for example, `read_timeout_ms=30000`) and leave one unspecified, the unspecified field remains `None` and that timeout stays disabled.
- Timeout failures are treated as network exceptions, and retry behavior is controlled by the configured retry strategy.
Expand Down
Loading