Skip to content

Commit a519a8b

Browse files
scaleway-botquantumsheep
scaleway-bot
and
quantumsheep
authored
feat(instance): add documentation on ListSnapshotsRequest (#302)
Co-authored-by: Nathanael Demacon <ndemacon@scaleway.com>
1 parent 7149df7 commit a519a8b

File tree

4 files changed

+84
-38
lines changed

4 files changed

+84
-38
lines changed

‎scaleway-async/scaleway_async/instance/v1/api.py‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1280,24 +1280,24 @@ async def list_snapshots(
12801280
*,
12811281
zone: Optional[Zone] = None,
12821282
organization: Optional[str] = None,
1283+
project: Optional[str] = None,
12831284
per_page: Optional[int] = None,
12841285
page: Optional[int] = None,
12851286
name: Optional[str] = None,
1286-
project: Optional[str] = None,
12871287
tags: Optional[str] = None,
12881288
base_volume_id: Optional[str] = None,
12891289
) -> ListSnapshotsResponse:
12901290
"""
12911291
List snapshots.
12921292
List all snapshots of an Organization in a specified Availability Zone.
12931293
:param zone: Zone to target. If none is passed will use default zone from the config.
1294-
:param organization:
1295-
:param per_page:
1296-
:param page:
1297-
:param name:
1298-
:param project:
1299-
:param tags:
1300-
:param base_volume_id:
1294+
:param organization: List snapshots only for this Organization ID.
1295+
:param project: List snapshots only for this Project ID.
1296+
:param per_page: Number of snapshots returned per page (positive integer lower or equal to 100).
1297+
:param page: Page to be returned.
1298+
:param name: List snapshots of the requested name.
1299+
:param tags: List snapshots that have the requested tag.
1300+
:param base_volume_id: List snapshots originating only from this volume.
13011301
:return: :class:`ListSnapshotsResponse <ListSnapshotsResponse>`
13021302
13031303
Usage:
@@ -1330,24 +1330,24 @@ async def list_snapshots_all(
13301330
*,
13311331
zone: Optional[Zone] = None,
13321332
organization: Optional[str] = None,
1333+
project: Optional[str] = None,
13331334
per_page: Optional[int] = None,
13341335
page: Optional[int] = None,
13351336
name: Optional[str] = None,
1336-
project: Optional[str] = None,
13371337
tags: Optional[str] = None,
13381338
base_volume_id: Optional[str] = None,
13391339
) -> List[Snapshot]:
13401340
"""
13411341
List snapshots.
13421342
List all snapshots of an Organization in a specified Availability Zone.
13431343
:param zone: Zone to target. If none is passed will use default zone from the config.
1344-
:param organization:
1345-
:param per_page:
1346-
:param page:
1347-
:param name:
1348-
:param project:
1349-
:param tags:
1350-
:param base_volume_id:
1344+
:param organization: List snapshots only for this Organization ID.
1345+
:param project: List snapshots only for this Project ID.
1346+
:param per_page: Number of snapshots returned per page (positive integer lower or equal to 100).
1347+
:param page: Page to be returned.
1348+
:param name: List snapshots of the requested name.
1349+
:param tags: List snapshots that have the requested tag.
1350+
:param base_volume_id: List snapshots originating only from this volume.
13511351
:return: :class:`List[ListSnapshotsResponse] <List[ListSnapshotsResponse]>`
13521352
13531353
Usage:
@@ -1363,10 +1363,10 @@ async def list_snapshots_all(
13631363
args={
13641364
"zone": zone,
13651365
"organization": organization,
1366+
"project": project,
13661367
"per_page": per_page,
13671368
"page": page,
13681369
"name": name,
1369-
"project": project,
13701370
"tags": tags,
13711371
"base_volume_id": base_volume_id,
13721372
},

‎scaleway-async/scaleway_async/instance/v1/types.py‎

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2279,16 +2279,39 @@ class ListSnapshotsRequest:
22792279
"""
22802280

22812281
organization: Optional[str]
2282+
"""
2283+
List snapshots only for this Organization ID.
2284+
"""
2285+
2286+
project: Optional[str]
2287+
"""
2288+
List snapshots only for this Project ID.
2289+
"""
22822290

22832291
per_page: Optional[int]
2292+
"""
2293+
Number of snapshots returned per page (positive integer lower or equal to 100).
2294+
"""
22842295

22852296
page: Optional[int]
2297+
"""
2298+
Page to be returned.
2299+
"""
22862300

22872301
name: Optional[str]
2288-
2289-
project: Optional[str]
2302+
"""
2303+
List snapshots of the requested name.
2304+
"""
22902305

22912306
tags: Optional[str]
2307+
"""
2308+
List snapshots that have the requested tag.
2309+
"""
2310+
2311+
base_volume_id: Optional[str]
2312+
"""
2313+
List snapshots originating only from this volume.
2314+
"""
22922315

22932316
base_volume_id: Optional[str]
22942317

‎scaleway/scaleway/instance/v1/api.py‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1280,24 +1280,24 @@ def list_snapshots(
12801280
*,
12811281
zone: Optional[Zone] = None,
12821282
organization: Optional[str] = None,
1283+
project: Optional[str] = None,
12831284
per_page: Optional[int] = None,
12841285
page: Optional[int] = None,
12851286
name: Optional[str] = None,
1286-
project: Optional[str] = None,
12871287
tags: Optional[str] = None,
12881288
base_volume_id: Optional[str] = None,
12891289
) -> ListSnapshotsResponse:
12901290
"""
12911291
List snapshots.
12921292
List all snapshots of an Organization in a specified Availability Zone.
12931293
:param zone: Zone to target. If none is passed will use default zone from the config.
1294-
:param organization:
1295-
:param per_page:
1296-
:param page:
1297-
:param name:
1298-
:param project:
1299-
:param tags:
1300-
:param base_volume_id:
1294+
:param organization: List snapshots only for this Organization ID.
1295+
:param project: List snapshots only for this Project ID.
1296+
:param per_page: Number of snapshots returned per page (positive integer lower or equal to 100).
1297+
:param page: Page to be returned.
1298+
:param name: List snapshots of the requested name.
1299+
:param tags: List snapshots that have the requested tag.
1300+
:param base_volume_id: List snapshots originating only from this volume.
13011301
:return: :class:`ListSnapshotsResponse <ListSnapshotsResponse>`
13021302
13031303
Usage:
@@ -1330,24 +1330,24 @@ def list_snapshots_all(
13301330
*,
13311331
zone: Optional[Zone] = None,
13321332
organization: Optional[str] = None,
1333+
project: Optional[str] = None,
13331334
per_page: Optional[int] = None,
13341335
page: Optional[int] = None,
13351336
name: Optional[str] = None,
1336-
project: Optional[str] = None,
13371337
tags: Optional[str] = None,
13381338
base_volume_id: Optional[str] = None,
13391339
) -> List[Snapshot]:
13401340
"""
13411341
List snapshots.
13421342
List all snapshots of an Organization in a specified Availability Zone.
13431343
:param zone: Zone to target. If none is passed will use default zone from the config.
1344-
:param organization:
1345-
:param per_page:
1346-
:param page:
1347-
:param name:
1348-
:param project:
1349-
:param tags:
1350-
:param base_volume_id:
1344+
:param organization: List snapshots only for this Organization ID.
1345+
:param project: List snapshots only for this Project ID.
1346+
:param per_page: Number of snapshots returned per page (positive integer lower or equal to 100).
1347+
:param page: Page to be returned.
1348+
:param name: List snapshots of the requested name.
1349+
:param tags: List snapshots that have the requested tag.
1350+
:param base_volume_id: List snapshots originating only from this volume.
13511351
:return: :class:`List[ListSnapshotsResponse] <List[ListSnapshotsResponse]>`
13521352
13531353
Usage:
@@ -1363,10 +1363,10 @@ def list_snapshots_all(
13631363
args={
13641364
"zone": zone,
13651365
"organization": organization,
1366+
"project": project,
13661367
"per_page": per_page,
13671368
"page": page,
13681369
"name": name,
1369-
"project": project,
13701370
"tags": tags,
13711371
"base_volume_id": base_volume_id,
13721372
},

‎scaleway/scaleway/instance/v1/types.py‎

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2279,16 +2279,39 @@ class ListSnapshotsRequest:
22792279
"""
22802280

22812281
organization: Optional[str]
2282+
"""
2283+
List snapshots only for this Organization ID.
2284+
"""
2285+
2286+
project: Optional[str]
2287+
"""
2288+
List snapshots only for this Project ID.
2289+
"""
22822290

22832291
per_page: Optional[int]
2292+
"""
2293+
Number of snapshots returned per page (positive integer lower or equal to 100).
2294+
"""
22842295

22852296
page: Optional[int]
2297+
"""
2298+
Page to be returned.
2299+
"""
22862300

22872301
name: Optional[str]
2288-
2289-
project: Optional[str]
2302+
"""
2303+
List snapshots of the requested name.
2304+
"""
22902305

22912306
tags: Optional[str]
2307+
"""
2308+
List snapshots that have the requested tag.
2309+
"""
2310+
2311+
base_volume_id: Optional[str]
2312+
"""
2313+
List snapshots originating only from this volume.
2314+
"""
22922315

22932316
base_volume_id: Optional[str]
22942317

0 commit comments

Comments
 (0)