Skip to content

fix(rdb): use BoolValue type for skip_size_retrieval option in ListDatabases endpoint #1344

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
merged 1 commit into from
Oct 31, 2025
Merged

fix(rdb): use BoolValue type for skip_size_retrieval option in ListDatabases endpoint #1344

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 5 additions & 7 deletions scaleway-async/scaleway_async/rdb/v1/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2451,25 +2451,25 @@ async def list_databases(
self,
*,
instance_id: str,
skip_size_retrieval: bool,
region: Optional[ScwRegion] = None,
name: Optional[str] = None,
managed: Optional[bool] = None,
owner: Optional[str] = None,
order_by: Optional[ListDatabasesRequestOrderBy] = None,
skip_size_retrieval: Optional[bool] = None,
page: Optional[int] = None,
page_size: Optional[int] = None,
) -> ListDatabasesResponse:
"""
List databases in a Database Instance.
List all databases of a given Database Instance. By default, the databases returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as `name`, `managed` and `owner`.
:param instance_id: UUID of the Database Instance to list the databases of.
:param skip_size_retrieval: Whether to skip the retrieval of each database size. If true, the size of each returned database will be set to 0.
:param region: Region to target. If none is passed will use default region from the config.
:param name: Name of the database.
:param managed: Defines whether or not the database is managed.
:param owner: User that owns this database.
:param order_by: Criteria to use when ordering database listing.
:param skip_size_retrieval: Whether to skip the retrieval of each database size. If true, the size of each returned database will be set to 0.
:param page:
:param page_size:
:return: :class:`ListDatabasesResponse <ListDatabasesResponse>`
Expand All @@ -2479,7 +2479,6 @@ async def list_databases(

result = await api.list_databases(
instance_id="example",
skip_size_retrieval=False,
)
"""

Expand Down Expand Up @@ -2509,25 +2508,25 @@ async def list_databases_all(
self,
*,
instance_id: str,
skip_size_retrieval: bool,
region: Optional[ScwRegion] = None,
name: Optional[str] = None,
managed: Optional[bool] = None,
owner: Optional[str] = None,
order_by: Optional[ListDatabasesRequestOrderBy] = None,
skip_size_retrieval: Optional[bool] = None,
page: Optional[int] = None,
page_size: Optional[int] = None,
) -> list[Database]:
"""
List databases in a Database Instance.
List all databases of a given Database Instance. By default, the databases returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as `name`, `managed` and `owner`.
:param instance_id: UUID of the Database Instance to list the databases of.
:param skip_size_retrieval: Whether to skip the retrieval of each database size. If true, the size of each returned database will be set to 0.
:param region: Region to target. If none is passed will use default region from the config.
:param name: Name of the database.
:param managed: Defines whether or not the database is managed.
:param owner: User that owns this database.
:param order_by: Criteria to use when ordering database listing.
:param skip_size_retrieval: Whether to skip the retrieval of each database size. If true, the size of each returned database will be set to 0.
:param page:
:param page_size:
:return: :class:`list[Database] <list[Database]>`
Expand All @@ -2537,7 +2536,6 @@ async def list_databases_all(

result = await api.list_databases_all(
instance_id="example",
skip_size_retrieval=False,
)
"""

Expand All @@ -2547,12 +2545,12 @@ async def list_databases_all(
fetcher=self.list_databases,
args={
"instance_id": instance_id,
"skip_size_retrieval": skip_size_retrieval,
"region": region,
"name": name,
"managed": managed,
"owner": owner,
"order_by": order_by,
"skip_size_retrieval": skip_size_retrieval,
"page": page,
"page_size": page_size,
},
Expand Down
10 changes: 5 additions & 5 deletions scaleway-async/scaleway_async/rdb/v1/types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1883,11 +1883,6 @@ class ListDatabasesRequest:
UUID of the Database Instance to list the databases of.
"""

skip_size_retrieval: bool
"""
Whether to skip the retrieval of each database size. If true, the size of each returned database will be set to 0.
"""

region: Optional[ScwRegion] = None
"""
Region to target. If none is passed will use default region from the config.
Expand Down Expand Up @@ -1915,6 +1910,11 @@ class ListDatabasesRequest:
Criteria to use when ordering database listing.
"""

skip_size_retrieval: Optional[bool] = False
"""
Whether to skip the retrieval of each database size. If true, the size of each returned database will be set to 0.
"""

page: Optional[int] = 0
page_size: Optional[int] = 0

Expand Down
12 changes: 5 additions & 7 deletions scaleway/scaleway/rdb/v1/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2443,25 +2443,25 @@ def list_databases(
self,
*,
instance_id: str,
skip_size_retrieval: bool,
region: Optional[ScwRegion] = None,
name: Optional[str] = None,
managed: Optional[bool] = None,
owner: Optional[str] = None,
order_by: Optional[ListDatabasesRequestOrderBy] = None,
skip_size_retrieval: Optional[bool] = None,
page: Optional[int] = None,
page_size: Optional[int] = None,
) -> ListDatabasesResponse:
"""
List databases in a Database Instance.
List all databases of a given Database Instance. By default, the databases returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as `name`, `managed` and `owner`.
:param instance_id: UUID of the Database Instance to list the databases of.
:param skip_size_retrieval: Whether to skip the retrieval of each database size. If true, the size of each returned database will be set to 0.
:param region: Region to target. If none is passed will use default region from the config.
:param name: Name of the database.
:param managed: Defines whether or not the database is managed.
:param owner: User that owns this database.
:param order_by: Criteria to use when ordering database listing.
:param skip_size_retrieval: Whether to skip the retrieval of each database size. If true, the size of each returned database will be set to 0.
:param page:
:param page_size:
:return: :class:`ListDatabasesResponse <ListDatabasesResponse>`
Expand All @@ -2471,7 +2471,6 @@ def list_databases(

result = api.list_databases(
instance_id="example",
skip_size_retrieval=False,
)
"""

Expand Down Expand Up @@ -2501,25 +2500,25 @@ def list_databases_all(
self,
*,
instance_id: str,
skip_size_retrieval: bool,
region: Optional[ScwRegion] = None,
name: Optional[str] = None,
managed: Optional[bool] = None,
owner: Optional[str] = None,
order_by: Optional[ListDatabasesRequestOrderBy] = None,
skip_size_retrieval: Optional[bool] = None,
page: Optional[int] = None,
page_size: Optional[int] = None,
) -> list[Database]:
"""
List databases in a Database Instance.
List all databases of a given Database Instance. By default, the databases returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as `name`, `managed` and `owner`.
:param instance_id: UUID of the Database Instance to list the databases of.
:param skip_size_retrieval: Whether to skip the retrieval of each database size. If true, the size of each returned database will be set to 0.
:param region: Region to target. If none is passed will use default region from the config.
:param name: Name of the database.
:param managed: Defines whether or not the database is managed.
:param owner: User that owns this database.
:param order_by: Criteria to use when ordering database listing.
:param skip_size_retrieval: Whether to skip the retrieval of each database size. If true, the size of each returned database will be set to 0.
:param page:
:param page_size:
:return: :class:`list[Database] <list[Database]>`
Expand All @@ -2529,7 +2528,6 @@ def list_databases_all(

result = api.list_databases_all(
instance_id="example",
skip_size_retrieval=False,
)
"""

Expand All @@ -2539,12 +2537,12 @@ def list_databases_all(
fetcher=self.list_databases,
args={
"instance_id": instance_id,
"skip_size_retrieval": skip_size_retrieval,
"region": region,
"name": name,
"managed": managed,
"owner": owner,
"order_by": order_by,
"skip_size_retrieval": skip_size_retrieval,
"page": page,
"page_size": page_size,
},
Expand Down
10 changes: 5 additions & 5 deletions scaleway/scaleway/rdb/v1/types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1883,11 +1883,6 @@ class ListDatabasesRequest:
UUID of the Database Instance to list the databases of.
"""

skip_size_retrieval: bool
"""
Whether to skip the retrieval of each database size. If true, the size of each returned database will be set to 0.
"""

region: Optional[ScwRegion] = None
"""
Region to target. If none is passed will use default region from the config.
Expand Down Expand Up @@ -1915,6 +1910,11 @@ class ListDatabasesRequest:
Criteria to use when ordering database listing.
"""

skip_size_retrieval: Optional[bool] = False
"""
Whether to skip the retrieval of each database size. If true, the size of each returned database will be set to 0.
"""

page: Optional[int] = 0
page_size: Optional[int] = 0

Expand Down