Skip to content

Commit 3b35cb7

Browse files
committed
Fix docstring inaccuracies in transport options\n\nClarify default_headers are sent to the origin server and fix\n_apply_transport_options param description to match its required\nsignature.
1 parent 46cf8a5 commit 3b35cb7

2 files changed

Lines changed: 2 additions & 2 deletions

File tree

zitadel_client/transport_options.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
class TransportOptions:
88
"""Immutable transport options for configuring HTTP connections.
99
10-
:param default_headers: Additional HTTP headers to include in every request.
10+
:param default_headers: Additional HTTP headers sent to the origin server with every request.
1111
:param ca_cert_path: Path to a custom CA certificate file for TLS verification.
1212
:param insecure: If True, disables TLS certificate verification.
1313
:param proxy_url: HTTP/HTTPS proxy URL to route requests through.

zitadel_client/zitadel.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ def _apply_transport_options(
191191
Apply transport options to the SDK configuration.
192192
193193
:param config: The Configuration instance to modify.
194-
:param transport_options: Optional transport options for TLS, proxy, and headers.
194+
:param transport_options: Transport options for TLS, proxy, and headers.
195195
"""
196196
config.default_headers = dict(transport_options.default_headers)
197197
if transport_options.ca_cert_path:

0 commit comments

Comments
 (0)