Skip to content

Commit c5e0ac8

Browse files
committed
fix: remove duration parameter from user data credentials API
1 parent eeac98d commit c5e0ac8

6 files changed

Lines changed: 9 additions & 38 deletions

File tree

docs/sdk/api.mdx

Lines changed: 3 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -728,41 +728,26 @@ def get_user(self) -> UserResponse:
728728
### get\_user\_data\_credentials
729729

730730
```python
731-
get_user_data_credentials(
732-
duration: int = DEFAULT_FS_CREDENTIAL_DURATION,
733-
) -> UserDataCredentials
731+
get_user_data_credentials() -> UserDataCredentials
734732
```
735733

736734
Retrieves user data credentials for secondary storage access.
737735

738-
**Parameters:**
739-
740-
* **`duration`**
741-
(`int`, default:
742-
`DEFAULT_FS_CREDENTIAL_DURATION`
743-
)
744-
–Credential lifetime in seconds (default: 4 hours)
745-
746736
**Returns:**
747737

748738
* `UserDataCredentials`
749739
–The user data credentials object.
750740

751741
<Accordion title="Source code in dreadnode/api/client.py" icon="code">
752742
```python
753-
def get_user_data_credentials(
754-
self, duration: int = DEFAULT_FS_CREDENTIAL_DURATION
755-
) -> UserDataCredentials:
743+
def get_user_data_credentials(self) -> UserDataCredentials:
756744
"""
757745
Retrieves user data credentials for secondary storage access.
758746
759-
Args:
760-
duration: Credential lifetime in seconds (default: 4 hours)
761-
762747
Returns:
763748
The user data credentials object.
764749
"""
765-
response = self._request("GET", "/user-data/credentials", params={"duration": duration})
750+
response = self._request("GET", "/user-data/credentials")
766751
return UserDataCredentials(**response.json())
767752
```
768753

docs/sdk/main.mdx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -526,9 +526,7 @@ def initialize(self) -> None:
526526
# )
527527
# )
528528
# )
529-
self._credentials = self._api.get_user_data_credentials(
530-
duration=DEFAULT_FS_CREDENTIAL_DURATION
531-
)
529+
self._credentials = self._api.get_user_data_credentials()
532530
self._credentials_expiry = self._credentials.expiration
533531
resolved_endpoint = resolve_endpoint(self._credentials.endpoint)
534532
self._fs = S3FileSystem(

dreadnode/api/client.py

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,6 @@
3737
process_task,
3838
)
3939
from dreadnode.constants import (
40-
DEFAULT_FS_CREDENTIAL_DURATION,
4140
DEFAULT_MAX_POLL_TIME,
4241
DEFAULT_POLL_INTERVAL,
4342
)
@@ -521,17 +520,12 @@ def export_timeseries(
521520

522521
# User data access
523522

524-
def get_user_data_credentials(
525-
self, duration: int = DEFAULT_FS_CREDENTIAL_DURATION
526-
) -> UserDataCredentials:
523+
def get_user_data_credentials(self) -> UserDataCredentials:
527524
"""
528525
Retrieves user data credentials for secondary storage access.
529526
530-
Args:
531-
duration: Credential lifetime in seconds (default: 4 hours)
532-
533527
Returns:
534528
The user data credentials object.
535529
"""
536-
response = self._request("GET", "/user-data/credentials", params={"duration": duration})
530+
response = self._request("GET", "/user-data/credentials")
537531
return UserDataCredentials(**response.json())

dreadnode/constants.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,5 +58,4 @@
5858
)
5959

6060
# Default values for the file system credential management
61-
DEFAULT_FS_CREDENTIAL_DURATION = 14400 # 4 hours in seconds
6261
FS_CREDENTIAL_REFRESH_BUFFER = 300 # 5 minutes in seconds

dreadnode/main.py

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@
2626
from dreadnode.api.client import ApiClient
2727
from dreadnode.config import UserConfig
2828
from dreadnode.constants import (
29-
DEFAULT_FS_CREDENTIAL_DURATION,
3029
DEFAULT_SERVER_URL,
3130
ENV_API_KEY,
3231
ENV_API_TOKEN,
@@ -353,9 +352,7 @@ def initialize(self) -> None:
353352
# )
354353
# )
355354
# )
356-
self._credentials = self._api.get_user_data_credentials(
357-
duration=DEFAULT_FS_CREDENTIAL_DURATION
358-
)
355+
self._credentials = self._api.get_user_data_credentials()
359356
self._credentials_expiry = self._credentials.expiration
360357
resolved_endpoint = resolve_endpoint(self._credentials.endpoint)
361358
self._fs = S3FileSystem(
@@ -427,9 +424,7 @@ def _refresh_storage_credentials(self) -> bool:
427424
):
428425
try:
429426
logger.info("Refreshing storage credentials")
430-
self._credentials = self._api.get_user_data_credentials(
431-
duration=DEFAULT_FS_CREDENTIAL_DURATION
432-
)
427+
self._credentials = self._api.get_user_data_credentials()
433428
self._credentials_expiry = self._credentials.expiration
434429

435430
resolved_endpoint = resolve_endpoint(self._credentials.endpoint)

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "dreadnode"
3-
version = "1.13.1"
3+
version = "1.13.2"
44
description = "Dreadnode SDK"
55
requires-python = ">=3.10,<3.14"
66

0 commit comments

Comments
 (0)