Skip to content

(minor) Forgot some (noncritical) rearranging of api options #417

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

Merged
erichare merged 2 commits into from
Jun 15, 2026
Merged

(minor) Forgot some (noncritical) rearranging of api options #417

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f7812d6
forgot some (noncritical) rearranging of api options
sl-at-ibm Jun 15, 2026
c8df99f
Merge branch 'main' into feat-verify-certs
erichare Jun 15, 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
26 changes: 15 additions & 11 deletions astrapy/utils/api_options.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -934,6 +934,12 @@ class APIOptions:
`astrapy.event_observers.Observer`) attached. The keys are the observer
names, the values are the observer objects. Interactions with the Data API
will dispatch events to all attached observers.
ca_cert_path: optional path to a custom CA certificate file (PEM format)
to use for SSL verification when connecting to the API. This is useful
for PrivateLink setups or other environments where a custom CA is needed.
When set, a per-instance SSL context is created with the given CA file
instead of using the default certifi-based CA bundle. Defaults to None
(use the bundled certifi CA roots).
timeout_options: an instance of `TimeoutOptions` (see) to control the timeout
behavior for the various kinds of operations involving the Data/DevOps API.
serdes_options: an instance of `SerdesOptions` (see) to customize the
Expand All @@ -945,12 +951,6 @@ class APIOptions:
dev_ops_api_url_options: an instance of `DevOpsAPIURLOptions` (see) to
customize the URL used to reach the DevOps API (customizing this setting
is rarely needed; relevant only for Astra DB environments).
ca_cert_path: optional path to a custom CA certificate file (PEM format)
to use for SSL verification when connecting to the API. This is useful
for PrivateLink setups or other environments where a custom CA is needed.
When set, a per-instance SSL context is created with the given CA file
instead of using the default certifi-based CA bundle. Defaults to None
(use the bundled certifi CA roots).

Examples:
>>> from astrapy import DataAPIClient
Expand Down Expand Up @@ -1029,7 +1029,6 @@ class APIOptions:
reranking_api_key: RerankingHeadersProvider | UnsetType = _UNSET
event_observers: dict[str, Observer | None] | UnsetType = _UNSET
ca_cert_path: str | None | UnsetType = _UNSET

timeout_options: TimeoutOptions | UnsetType = _UNSET
serdes_options: SerdesOptions | UnsetType = _UNSET
data_api_url_options: DataAPIURLOptions | UnsetType = _UNSET
Expand Down Expand Up @@ -1131,6 +1130,9 @@ def __repr__(self) -> str:
if isinstance(self.event_observers, UnsetType)
else f"event_observers={','.join(self.event_observers.keys())}",
None
if isinstance(self.ca_cert_path, UnsetType)
else f"ca_cert_path={self.ca_cert_path}",
None
if isinstance(self.timeout_options, UnsetType)
else f"timeout_options={self.timeout_options}",
None
Expand All @@ -1142,9 +1144,6 @@ def __repr__(self) -> str:
None
if isinstance(self.dev_ops_api_url_options, UnsetType)
else f"dev_ops_api_url_options={self.dev_ops_api_url_options}",
None
if isinstance(self.ca_cert_path, UnsetType)
else f"ca_cert_path={self.ca_cert_path}",
)
if pc is not None
]
Expand Down Expand Up @@ -1209,6 +1208,12 @@ class FullAPIOptions(APIOptions):
`astrapy.event_observers.Observer`) attached. Keys are the observer names,
each associated to the observer object. Interactions with the Data API
will dispatch events to all attached observers.
ca_cert_path: optional path to a custom CA certificate file (PEM format)
to use for SSL verification when connecting to the API. This is useful
for PrivateLink setups or other environments where a custom CA is needed.
When set, a per-instance SSL context is created with the given CA file
instead of using the default certifi-based CA bundle. Defaults to None
(use the bundled certifi CA roots).
timeout_options: an instance of `TimeoutOptions` (see) to control the timeout
behavior for the various kinds of operations involving the Data/DevOps API.
serdes_options: an instance of `SerdesOptions` (see) to customize the
Expand All @@ -1232,7 +1237,6 @@ class FullAPIOptions(APIOptions):
reranking_api_key: RerankingHeadersProvider
event_observers: dict[str, Observer | None]
ca_cert_path: str | None

timeout_options: FullTimeoutOptions
serdes_options: FullSerdesOptions
data_api_url_options: FullDataAPIURLOptions
Expand Down
Loading