Skip to content

Commit 0b8c73a

Browse files
authored
chore(storage-boxes): add experimental markers to all clients and methods (#604)
I added the `Experimental` markers as described in https://hcloud-python.readthedocs.io/en/stable/#experimental-features I saw that for DNS we only marked the methods. The docs specify that classes should also be marked, so I added it to the clients too.
1 parent cfc6d97 commit 0b8c73a

File tree

2 files changed

+208
-1
lines changed

2 files changed

+208
-1
lines changed

hcloud/storage_box_types/client.py

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,9 @@ class StorageBoxTypesClient(ResourceClientBase):
2525
A client for the Storage Box Types API.
2626
2727
See https://docs.hetzner.cloud/reference/hetzner#storage-box-types.
28+
29+
Experimental:
30+
Storage Box support is experimental, breaking changes may occur within minor releases.
2831
"""
2932

3033
_base_url = "/storage_box_types"
@@ -40,6 +43,9 @@ def get_by_id(self, id: int) -> BoundStorageBoxType:
4043
See https://docs.hetzner.cloud/reference/hetzner#storage-box-types-get-a-storage-box-type
4144
4245
:param id: ID of the Storage Box Type.
46+
47+
Experimental:
48+
Storage Box support is experimental, breaking changes may occur within minor releases.
4349
"""
4450
response = self._client.request(
4551
method="GET",
@@ -54,6 +60,9 @@ def get_by_name(self, name: str) -> BoundStorageBoxType | None:
5460
See https://docs.hetzner.cloud/reference/hetzner#storage-box-types-list-storage-box-types
5561
5662
:param name: Name of the Storage Box Type.
63+
64+
Experimental:
65+
Storage Box support is experimental, breaking changes may occur within minor releases.
5766
"""
5867
return self._get_first_by(self.get_list, name=name)
5968

@@ -71,6 +80,9 @@ def get_list(
7180
:param name: Name of the Storage Box Type.
7281
:param page: Page number to return.
7382
:param per_page: Maximum number of entries returned per page.
83+
84+
Experimental:
85+
Storage Box support is experimental, breaking changes may occur within minor releases.
7486
"""
7587
params: dict[str, Any] = {}
7688
if name is not None:
@@ -102,6 +114,9 @@ def get_all(
102114
See https://docs.hetzner.cloud/reference/hetzner#storage-box-types-list-storage-box-types
103115
104116
:param name: Name of the Storage Box Type.
117+
118+
Experimental:
119+
Storage Box support is experimental, breaking changes may occur within minor releases.
105120
"""
106121
return self._iter_pages(
107122
self.get_list,

0 commit comments

Comments
 (0)