feat(block): improve arguments configuration (#4275)

Co-authored-by: Jules Castéran <jcasteran@scaleway.com>
scaleway · Nov 18, 2024 · d386384 · d386384
1 parent 8f0a8ea
commit d386384
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 14 deletions.
diff --git a/cmd/scw/testdata/test-all-usage-block-snapshot-create-usage.golden b/cmd/scw/testdata/test-all-usage-block-snapshot-create-usage.golden
@@ -7,11 +7,11 @@ USAGE:
   scw block snapshot create [arg=value ...]
 
 ARGS:
-  [volume-id]       UUID of the volume to snapshot
-  [name]            Name of the snapshot
-  [project-id]      Project ID to use. If none is passed the default project ID will be used
-  [tags.{index}]    List of tags assigned to the snapshot
-  [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)
+  [volume-id]          UUID of the volume to snapshot
+  [name=<generated>]   Name of the snapshot
+  [project-id]         Project ID to use. If none is passed the default project ID will be used
+  [tags.{index}]       List of tags assigned to the snapshot
+  [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)
 
 FLAGS:
   -h, --help   help for create

diff --git a/cmd/scw/testdata/test-all-usage-block-snapshot-delete-usage.golden b/cmd/scw/testdata/test-all-usage-block-snapshot-delete-usage.golden
@@ -3,7 +3,7 @@
 You must specify the `snapshot_id` of the snapshot you want to delete. The snapshot must not be in use.
 
 USAGE:
-  scw block snapshot delete [arg=value ...]
+  scw block snapshot delete <snapshot-id ...> [arg=value ...]
 
 ARGS:
   snapshot-id       UUID of the snapshot

diff --git a/cmd/scw/testdata/test-all-usage-block-volume-create-usage.golden b/cmd/scw/testdata/test-all-usage-block-volume-create-usage.golden
@@ -7,7 +7,7 @@ USAGE:
   scw block volume create [arg=value ...]
 
 ARGS:
-  name                          Name of the volume
+  name=<generated>              Name of the volume
   perf-iops                     The maximum IO/s expected, according to the different options available in stock (`5000 | 15000`)
   [project-id]                  Project ID to use. If none is passed the default project ID will be used
   [from-empty.size]             Volume size in bytes, with a granularity of 1 GB (10^9 bytes)

diff --git a/cmd/scw/testdata/test-all-usage-block-volume-delete-usage.golden b/cmd/scw/testdata/test-all-usage-block-volume-delete-usage.golden
@@ -3,7 +3,7 @@
 You must specify the `volume_id` of the volume you want to delete. The volume must not be in the `in_use` status.
 
 USAGE:
-  scw block volume delete [arg=value ...]
+  scw block volume delete <volume-id ...> [arg=value ...]
 
 ARGS:
   volume-id         UUID of the volume

diff --git a/docs/commands/block.md b/docs/commands/block.md
@@ -42,7 +42,7 @@ scw block snapshot create [arg=value ...]
 | Name |   | Description |
 |------|---|-------------|
 | volume-id |  | UUID of the volume to snapshot |
-| name |  | Name of the snapshot |
+| name | Default: `<generated>` | Name of the snapshot |
 | project-id |  | Project ID to use. If none is passed the default project ID will be used |
 | tags.{index} |  | List of tags assigned to the snapshot |
 | 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` | Zone to target. If none is passed will use default zone from the config |
@@ -56,7 +56,7 @@ You must specify the `snapshot_id` of the snapshot you want to delete. The snaps
 **Usage:**
 
 ```
-scw block snapshot delete [arg=value ...]
+scw block snapshot delete <snapshot-id ...> [arg=value ...]
 ```
 
 
@@ -205,7 +205,7 @@ scw block volume create [arg=value ...]
 
 | Name |   | Description |
 |------|---|-------------|
-| name | Required | Name of the volume |
+| name | Required<br />Default: `<generated>` | Name of the volume |
 | perf-iops | Required | The maximum IO/s expected, according to the different options available in stock (`5000 | 15000`) |
 | project-id |  | Project ID to use. If none is passed the default project ID will be used |
 | from-empty.size |  | Volume size in bytes, with a granularity of 1 GB (10^9 bytes) |
@@ -223,7 +223,7 @@ You must specify the `volume_id` of the volume you want to delete. The volume mu
 **Usage:**
 
 ```
-scw block volume delete [arg=value ...]
+scw block volume delete <volume-id ...> [arg=value ...]
 ```
 
 

diff --git a/internal/namespaces/block/v1alpha1/block_cli.go b/internal/namespaces/block/v1alpha1/block_cli.go
@@ -197,6 +197,7 @@ To create a volume from an existing snapshot, specify ` + "`" + `from_snapshot`
 				Required:   true,
 				Deprecated: false,
 				Positional: false,
+				Default:    core.RandomValueGenerator("vol"),
 			},
 			{
 				Name:       "perf-iops",
@@ -292,7 +293,7 @@ func blockVolumeDelete() *core.Command {
 				Short:      `UUID of the volume`,
 				Required:   true,
 				Deprecated: false,
-				Positional: false,
+				Positional: true,
 			},
 			core.ZoneArgSpec(scw.ZoneFrPar1, scw.ZoneFrPar2, scw.ZoneFrPar3, scw.ZoneNlAms1, scw.ZoneNlAms2, scw.ZoneNlAms3, scw.ZonePlWaw1, scw.ZonePlWaw2, scw.ZonePlWaw3),
 		},
@@ -494,6 +495,7 @@ If your volume is in a transient state, you need to wait until the end of the cu
 				Required:   false,
 				Deprecated: false,
 				Positional: false,
+				Default:    core.RandomValueGenerator("snp"),
 			},
 			core.ProjectIDArgSpec(),
 			{
@@ -636,7 +638,7 @@ func blockSnapshotDelete() *core.Command {
 				Short:      `UUID of the snapshot`,
 				Required:   true,
 				Deprecated: false,
-				Positional: false,
+				Positional: true,
 			},
 			core.ZoneArgSpec(scw.ZoneFrPar1, scw.ZoneFrPar2, scw.ZoneFrPar3, scw.ZoneNlAms1, scw.ZoneNlAms2, scw.ZoneNlAms3, scw.ZonePlWaw1, scw.ZonePlWaw2, scw.ZonePlWaw3),
 		},