Skip to content

Commit da26daf

Browse files
committed
Add missing param docstrings for transport_options
1 parent 231dafc commit da26daf

3 files changed

Lines changed: 19 additions & 1 deletion

File tree

zitadel_client/auth/open_id.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,12 @@ def __init__( # noqa: C901
2525
hostname: str,
2626
transport_options: Optional[TransportOptions] = None,
2727
):
28+
"""
29+
Initialize the OpenId configuration fetcher.
30+
31+
:param hostname: The Zitadel instance hostname or URL.
32+
:param transport_options: Optional transport options for TLS, proxy, and headers.
33+
"""
2834
if transport_options is None:
2935
transport_options = TransportOptions.defaults()
3036

zitadel_client/transport_options.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,13 @@
55

66
@dataclass(frozen=True)
77
class TransportOptions:
8-
"""Immutable transport options for configuring HTTP connections."""
8+
"""Immutable transport options for configuring HTTP connections.
9+
10+
:param default_headers: Additional HTTP headers to include in every request.
11+
:param ca_cert_path: Path to a custom CA certificate file for TLS verification.
12+
:param insecure: If True, disables TLS certificate verification.
13+
:param proxy_url: HTTP/HTTPS proxy URL to route requests through.
14+
"""
915

1016
default_headers: Mapping[str, str] = field(default_factory=dict)
1117
ca_cert_path: Optional[str] = None

zitadel_client/zitadel.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,12 @@ def _apply_transport_options(
187187
config: Configuration,
188188
transport_options: TransportOptions,
189189
) -> None:
190+
"""
191+
Apply transport options to the SDK configuration.
192+
193+
:param config: The Configuration instance to modify.
194+
:param transport_options: Optional transport options for TLS, proxy, and headers.
195+
"""
190196
config.default_headers = dict(transport_options.default_headers)
191197
if transport_options.ca_cert_path:
192198
config.ssl_ca_cert = transport_options.ca_cert_path

0 commit comments

Comments
 (0)