feat(instance): add documentation on ListSnapshotsRequest (#3376)

Author: scaleway-bot

cmd/scw/testdata/test-all-usage-instance-snapshot-list-usage.golden

@@ -13,11 +13,11 @@ EXAMPLES:
     scw instance snapshot list zone=fr-par-1
 
 ARGS:
-  [name]              
-  [project-id]        
-  [tags]              
-  [base-volume-id]    
-  [organization-id]   
+  [project-id]        List snapshots only for this Project ID
+  [name]              List snapshots of the requested name
+  [tags]              List snapshots that have the requested tag
+  [base-volume-id]    List snapshots originating only from this volume
+  [organization-id]   List snapshots only for this Organization ID
   [zone=fr-par-1]     Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | nl-ams-3 | pl-waw-1 | pl-waw-2 | pl-waw-3 | all)
 
 FLAGS:

docs/commands/instance.md

@@ -2601,11 +2601,11 @@ scw instance snapshot list [arg=value ...]
 
 | Name |   | Description |
 |------|---|-------------|
-| name |  |  |
-| project-id |  |  |
-| tags |  |  |
-| base-volume-id |  |  |
-| organization-id |  |  |
+| project-id |  | List snapshots only for this Project ID |
+| name |  | List snapshots of the requested name |
+| tags |  | List snapshots that have the requested tag |
+| base-volume-id |  | List snapshots originating only from this volume |
+| organization-id |  | List snapshots only for this Organization ID |
 | zone | Default: `fr-par-1`<br />One of: `fr-par-1`, `fr-par-2`, `fr-par-3`, `nl-ams-1`, `nl-ams-2`, `nl-ams-3`, `pl-waw-1`, `pl-waw-2`, `pl-waw-3`, `all` | Zone to target. If none is passed will use default zone from the config |
 
 

go.mod

@@ -24,7 +24,7 @@ require (
 	github.com/moby/buildkit v0.11.6
 	github.com/opencontainers/go-digest v1.0.0
 	github.com/pkg/errors v0.9.1
-	github.com/scaleway/scaleway-sdk-go v1.0.0-beta.21.0.20230919140146-a731a0058f98
+	github.com/scaleway/scaleway-sdk-go v1.0.0-beta.21.0.20230920081818-d2f8a2eef94c
 	github.com/skratchdot/open-golang v0.0.0-20200116055534-eef842397966
 	github.com/spf13/cobra v1.7.0
 	github.com/spf13/pflag v1.0.5

go.sum

@@ -491,8 +491,8 @@ github.com/rogpeppe/go-internal v1.10.0/go.mod h1:UQnix2H7Ngw/k4C5ijL5+65zddjncj
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
 github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06 h1:OkMGxebDjyw0ULyrTYWeN0UNCCkmCWfjPnIA2W6oviI=
 github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06/go.mod h1:+ePHsJ1keEjQtpvf9HHw0f4ZeJ0TLRsxhunSI2hYJSs=
-github.com/scaleway/scaleway-sdk-go v1.0.0-beta.21.0.20230919140146-a731a0058f98 h1:iqhgEyhgtkgQzptcemy9csJIzdg7RS64a9Przn2ZDGk=
-github.com/scaleway/scaleway-sdk-go v1.0.0-beta.21.0.20230919140146-a731a0058f98/go.mod h1:fCa7OJZ/9DRTnOKmxvT6pn+LPWUptQAmHF/SBJUGEcg=
+github.com/scaleway/scaleway-sdk-go v1.0.0-beta.21.0.20230920081818-d2f8a2eef94c h1:ycZnnSiUFyH4YBkkpw81AHrqtDMRn+sf+1qkFSoSUUQ=
+github.com/scaleway/scaleway-sdk-go v1.0.0-beta.21.0.20230920081818-d2f8a2eef94c/go.mod h1:fCa7OJZ/9DRTnOKmxvT6pn+LPWUptQAmHF/SBJUGEcg=
 github.com/sclevine/spec v1.4.0 h1:z/Q9idDcay5m5irkZ28M7PtQM4aOISzOpj4bUPkDee8=
 github.com/secure-systems-lab/go-securesystemslib v0.4.0 h1:b23VGrQhTA8cN2CbBw7/FulN9fTtqYUdS5+Oxzt+DUE=
 github.com/sergi/go-diff v1.0.0/go.mod h1:0CfEIISq7TuYL3j771MWULgwwjU+GofnZX9QAmXWZgo=

internal/namespaces/instance/v1/instance_cli.go

@@ -1334,31 +1334,36 @@ func instanceSnapshotList() *core.Command {
 		ArgsType: reflect.TypeOf(instance.ListSnapshotsRequest{}),
 		ArgSpecs: core.ArgSpecs{
 			{
-				Name:       "name",
+				Name:       "project",
+				Short:      `List snapshots only for this Project ID`,
 				Required:   false,
 				Deprecated: false,
 				Positional: false,
 			},
 			{
-				Name:       "project",
+				Name:       "name",
+				Short:      `List snapshots of the requested name`,
 				Required:   false,
 				Deprecated: false,
 				Positional: false,
 			},
 			{
 				Name:       "tags",
+				Short:      `List snapshots that have the requested tag`,
 				Required:   false,
 				Deprecated: false,
 				Positional: false,
 			},
 			{
 				Name:       "base-volume-id",
+				Short:      `List snapshots originating only from this volume`,
 				Required:   false,
 				Deprecated: false,
 				Positional: false,
 			},
 			{
 				Name:       "organization",
+				Short:      `List snapshots only for this Organization ID`,
 				Required:   false,
 				Deprecated: false,
 				Positional: false,