Skip to content

Commit cf217d4

Browse files
Clarify proxy bypass guidance in Python SDK README
1 parent 6c894c9 commit cf217d4

2 files changed

Lines changed: 4 additions & 2 deletions

File tree

‎sdks/python/README.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,10 @@ Version 2.0.0 is generated with OpenAPI Generator 7.26.0. Existing code keeps wo
88
- **Python 3.10 or later is required.** Python 3.8 and 3.9 are no longer supported; pip keeps installing 1.x on those versions.
99
- **Dependencies:** `urllib3 >= 2.8.0` and `pydantic >= 2.11`.
1010
- **Proxy settings are now detected automatically.** When `Configuration.proxy` is not set, the SDK uses the proxy configured in the environment (`HTTPS_PROXY`, `HTTP_PROXY`, `ALL_PROXY`) and, on macOS and Windows, the system proxy settings. Previously, a proxy was only used when set explicitly.
11-
- To bypass the proxy for the Dropbox Sign API, set `NO_PROXY=api.hellosign.com` or `configuration.no_proxy = "api.hellosign.com"`.
11+
- To bypass the proxy for the Dropbox Sign API, set `NO_PROXY=hellosign.com` or `configuration.no_proxy = "hellosign.com"`. This covers both `api.hellosign.com` and `app.hellosign.com` (used by the OAuth endpoints).
1212
- To ignore all proxy settings, set `configuration.proxy = None` after creating the `Configuration` and before creating the `ApiClient`. Passing `proxy=None` to the constructor does not disable detection.
1313
- SOCKS proxies (for example `ALL_PROXY=socks5://...`) require `pip install "urllib3[socks]"`.
14+
- Known limitations: the proxy decision is made once per `ApiClient` for the configured host, and macOS/Windows proxy exclusion lists and PAC files are not applied. If you rely on them, set `NO_PROXY` or `configuration.no_proxy` explicitly.
1415
- **Behaviour changes:** `to_json()` now serializes datetimes, `to_dict()` keeps `None` items in lists, boolean query parameters are sent as `true` / `false`, and the `ApiException` message lists the response body and data separately.
1516

1617
## Migrating from legacy SDK

‎sdks/python/templates/README.mustache‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,9 +72,10 @@ Version 2.0.0 is generated with OpenAPI Generator 7.26.0. Existing code keeps wo
7272
- **Python 3.10 or later is required.** Python 3.8 and 3.9 are no longer supported; pip keeps installing 1.x on those versions.
7373
- **Dependencies:** `urllib3 >= 2.8.0` and `pydantic >= 2.11`.
7474
- **Proxy settings are now detected automatically.** When `Configuration.proxy` is not set, the SDK uses the proxy configured in the environment (`HTTPS_PROXY`, `HTTP_PROXY`, `ALL_PROXY`) and, on macOS and Windows, the system proxy settings. Previously, a proxy was only used when set explicitly.
75-
- To bypass the proxy for the Dropbox Sign API, set `NO_PROXY=api.hellosign.com` or `configuration.no_proxy = "api.hellosign.com"`.
75+
- To bypass the proxy for the Dropbox Sign API, set `NO_PROXY=hellosign.com` or `configuration.no_proxy = "hellosign.com"`. This covers both `api.hellosign.com` and `app.hellosign.com` (used by the OAuth endpoints).
7676
- To ignore all proxy settings, set `configuration.proxy = None` after creating the `Configuration` and before creating the `ApiClient`. Passing `proxy=None` to the constructor does not disable detection.
7777
- SOCKS proxies (for example `ALL_PROXY=socks5://...`) require `pip install "urllib3[socks]"`.
78+
- Known limitations: the proxy decision is made once per `ApiClient` for the configured host, and macOS/Windows proxy exclusion lists and PAC files are not applied. If you rely on them, set `NO_PROXY` or `configuration.no_proxy` explicitly.
7879
- **Behaviour changes:** `to_json()` now serializes datetimes, `to_dict()` keeps `None` items in lists, boolean query parameters are sent as `true` / `false`, and the `ApiException` message lists the response body and data separately.
7980

8081
## Migrating from legacy SDK

0 commit comments

Comments
 (0)