Skip to content

feat(instance): add documentation on ListSnapshotsRequest #302

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 2 commits into from
Sep 25, 2023
Merged

feat(instance): add documentation on ListSnapshotsRequest #302

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
939760f
feat: update generated APIs
scaleway-bot Sep 20, 2023
f4fe5de
Merge branch 'main' into v1.4031.0
quantumsheep Sep 25, 2023
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
42 changes: 27 additions & 15 deletions scaleway-async/scaleway_async/instance/v1/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1280,22 +1280,24 @@ async def list_snapshots(
*,
zone: Optional[Zone] = None,
organization: Optional[str] = None,
project: Optional[str] = None,
per_page: Optional[int] = None,
page: Optional[int] = None,
name: Optional[str] = None,
project: Optional[str] = None,
tags: Optional[str] = None,
base_volume_id: Optional[str] = None,
) -> ListSnapshotsResponse:
"""
List snapshots.
List all snapshots of an Organization in a specified Availability Zone.
:param zone: Zone to target. If none is passed will use default zone from the config.
:param organization:
:param per_page:
:param page:
:param name:
:param project:
:param tags:
:param organization: List snapshots only for this Organization ID.
:param project: List snapshots only for this Project ID.
:param per_page: Number of snapshots returned per page (positive integer lower or equal to 100).
:param page: Page to be returned.
:param name: List snapshots of the requested name.
:param tags: List snapshots that have the requested tag.
:param base_volume_id: List snapshots originating only from this volume.
:return: :class:`ListSnapshotsResponse <ListSnapshotsResponse>`

Usage:
Expand All @@ -1310,6 +1312,7 @@ async def list_snapshots(
"GET",
f"/instance/v1/zones/{param_zone}/snapshots",
params={
"base_volume_id": base_volume_id,
"name": name,
"organization": organization or self.client.default_organization_id,
"page": page,
Expand All @@ -1327,22 +1330,24 @@ async def list_snapshots_all(
*,
zone: Optional[Zone] = None,
organization: Optional[str] = None,
project: Optional[str] = None,
per_page: Optional[int] = None,
page: Optional[int] = None,
name: Optional[str] = None,
project: Optional[str] = None,
tags: Optional[str] = None,
base_volume_id: Optional[str] = None,
) -> List[Snapshot]:
"""
List snapshots.
List all snapshots of an Organization in a specified Availability Zone.
:param zone: Zone to target. If none is passed will use default zone from the config.
:param organization:
:param per_page:
:param page:
:param name:
:param project:
:param tags:
:param organization: List snapshots only for this Organization ID.
:param project: List snapshots only for this Project ID.
:param per_page: Number of snapshots returned per page (positive integer lower or equal to 100).
:param page: Page to be returned.
:param name: List snapshots of the requested name.
:param tags: List snapshots that have the requested tag.
:param base_volume_id: List snapshots originating only from this volume.
:return: :class:`List[ListSnapshotsResponse] <List[ListSnapshotsResponse]>`

Usage:
Expand All @@ -1358,11 +1363,12 @@ async def list_snapshots_all(
args={
"zone": zone,
"organization": organization,
"project": project,
"per_page": per_page,
"page": page,
"name": name,
"project": project,
"tags": tags,
"base_volume_id": base_volume_id,
},
)

Expand Down Expand Up @@ -3040,6 +3046,7 @@ async def list_ips(
name: Optional[str] = None,
per_page: Optional[int] = None,
page: Optional[int] = None,
type_: Optional[str] = None,
) -> ListIpsResponse:
"""
List all flexible IPs.
Expand All @@ -3051,6 +3058,7 @@ async def list_ips(
:param name: Filter on the IP address (Works as a LIKE operation on the IP address).
:param per_page: A positive integer lower or equal to 100 to select the number of items to return.
:param page: A positive integer to choose the page to return.
:param type_: Filter on the IP Mobility IP type (whose value should be either 'nat', 'routed_ipv4' or 'routed_ipv6').
:return: :class:`ListIpsResponse <ListIpsResponse>`

Usage:
Expand All @@ -3071,6 +3079,7 @@ async def list_ips(
"per_page": per_page or self.client.default_page_size,
"project": project or self.client.default_project_id,
"tags": ",".join(tags) if tags and len(tags) > 0 else None,
"type": type_,
},
)

Expand All @@ -3087,6 +3096,7 @@ async def list_ips_all(
name: Optional[str] = None,
per_page: Optional[int] = None,
page: Optional[int] = None,
type_: Optional[str] = None,
) -> List[Ip]:
"""
List all flexible IPs.
Expand All @@ -3098,6 +3108,7 @@ async def list_ips_all(
:param name: Filter on the IP address (Works as a LIKE operation on the IP address).
:param per_page: A positive integer lower or equal to 100 to select the number of items to return.
:param page: A positive integer to choose the page to return.
:param type_: Filter on the IP Mobility IP type (whose value should be either 'nat', 'routed_ipv4' or 'routed_ipv6').
:return: :class:`List[ListIpsResponse] <List[ListIpsResponse]>`

Usage:
Expand All @@ -3118,6 +3129,7 @@ async def list_ips_all(
"name": name,
"per_page": per_page,
"page": page,
"type_": type_,
},
)

Expand Down
Loading