Skip to content

Commit 5000773

Browse files
docs(instance): fix example for image create (#1995)
Co-authored-by: Rémy Léone <[email protected]>
1 parent 4470607 commit 5000773

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

cmd/scw/testdata/test-all-usage-instance-image-create-usage.golden

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ USAGE:
66
scw instance image create [arg=value ...]
77

88
EXAMPLES:
9-
Create an image named 'foobar' for x86_64 instances from the given root_volume ID (root_volume ID needs to be a snapshot UUID)
10-
scw instance image create name=foobar root-volume=11111111-1111-1111-1111-111111111111 arch=x86_64
9+
Create an image named 'foobar' for x86_64 instances from the given snapshot ID
10+
scw instance image create name=foobar snapshot-id=11111111-1111-1111-1111-111111111111 arch=x86_64
1111

1212
ARGS:
1313
[name=<generated>] Name of the image

docs/commands/instance.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,9 +119,9 @@ scw instance image create [arg=value ...]
119119
**Examples:**
120120

121121

122-
Create an image named 'foobar' for x86_64 instances from the given root_volume ID (root_volume ID needs to be a snapshot UUID)
122+
Create an image named 'foobar' for x86_64 instances from the given snapshot ID
123123
```
124-
scw instance image create name=foobar root-volume=11111111-1111-1111-1111-111111111111 arch=x86_64
124+
scw instance image create name=foobar snapshot-id=11111111-1111-1111-1111-111111111111 arch=x86_64
125125
```
126126

127127

internal/namespaces/instance/v1/instance_cli.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1098,8 +1098,8 @@ func instanceImageCreate() *core.Command {
10981098
},
10991099
Examples: []*core.Example{
11001100
{
1101-
Short: "Create an image named 'foobar' for x86_64 instances from the given root_volume ID (root_volume ID needs to be a snapshot UUID)",
1102-
ArgsJSON: `{"arch":"x86_64","name":"foobar","root_volume":"11111111-1111-1111-1111-111111111111"}`,
1101+
Short: "Create an image named 'foobar' for x86_64 instances from the given snapshot ID",
1102+
Raw: `scw instance image create name=foobar snapshot-id=11111111-1111-1111-1111-111111111111 arch=x86_64`,
11031103
},
11041104
},
11051105
}

0 commit comments

Comments
 (0)