Skip to content

Commit 3b0cc66

Browse files
committed
update doc
1 parent d2004bc commit 3b0cc66

File tree

4 files changed

+11
-11
lines changed

4 files changed

+11
-11
lines changed

cmd/scw/testdata/test-all-usage-instance-server-action-usage.golden

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Perform an action on a server
3+
Perform a raw API action on a server
44

55
USAGE:
66
scw instance server action <server-id ...> [arg=value ...]
77

88
EXAMPLES:
99
Start a server in the default zone with a given id
10-
scw instance server action 11111111-1111-1111-1111-111111111111 action=start
10+
scw instance server action 11111111-1111-1111-1111-111111111111 action=poweron
1111

1212
ARGS:
13-
action The action to perform
13+
action The raw API action to perform, as listed with 'scw instance server list-actions'
1414
server-id ID of the server affected by the action.
1515
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config
1616

cmd/scw/testdata/test-all-usage-instance-server-usage.golden

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ USAGE:
88
scw instance server <command>
99

1010
AVAILABLE COMMANDS:
11-
action Perform an action on a server
11+
action Perform a raw API action on a server
1212
attach-ip Attach an IP to a server
1313
attach-volume Attach a volume to a server
1414
backup Backup server

docs/commands/instance.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Instance API.
4848
- [Update all the rules of a security group](#update-all-the-rules-of-a-security-group)
4949
- [Update security group](#update-security-group)
5050
- [Instance management commands](#instance-management-commands)
51-
- [Perform an action on a server](#perform-an-action-on-a-server)
51+
- [Perform a raw API action on a server](#perform-a-raw-api-action-on-a-server)
5252
- [Attach an IP to a server](#attach-an-ip-to-a-server)
5353
- [Attach a volume to a server](#attach-a-volume-to-a-server)
5454
- [Backup server](#backup-server)
@@ -1562,7 +1562,7 @@ Scaleway offers various Instance types including **Virtual Instances** and **ded
15621562

15631563

15641564

1565-
### Perform an action on a server
1565+
### Perform a raw API action on a server
15661566

15671567

15681568

@@ -1577,7 +1577,7 @@ scw instance server action <server-id ...> [arg=value ...]
15771577

15781578
| Name | | Description |
15791579
|------|---|-------------|
1580-
| action | Required | The action to perform |
1580+
| action | Required | The raw API action to perform, as listed with 'scw instance server list-actions' |
15811581
| server-id | Required | ID of the server affected by the action. |
15821582
| zone | Default: `fr-par-1` | Zone to target. If none is passed will use default zone from the config |
15831583

@@ -1587,7 +1587,7 @@ scw instance server action <server-id ...> [arg=value ...]
15871587

15881588
Start a server in the default zone with a given id
15891589
```
1590-
scw instance server action 11111111-1111-1111-1111-111111111111 action=start
1590+
scw instance server action 11111111-1111-1111-1111-111111111111 action=poweron
15911591
```
15921592

15931593

internal/namespaces/instance/v1/custom_server_action.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -482,12 +482,12 @@ func serverActionCommand() *core.Command {
482482
argSpecs := serverActionArgSpecs
483483
argSpecs.AddBefore("server-id", &core.ArgSpec{
484484
Name: "action",
485-
Short: "The action to perform",
485+
Short: "The raw API action to perform, as listed with 'scw instance server list-actions'",
486486
Required: true,
487487
})
488488

489489
return &core.Command{
490-
Short: `Perform an action on a server`,
490+
Short: `Perform a raw API action on a server`,
491491
Namespace: "instance",
492492
Resource: "server",
493493
Verb: "action",
@@ -512,7 +512,7 @@ func serverActionCommand() *core.Command {
512512
Examples: []*core.Example{
513513
{
514514
Short: "Start a server in the default zone with a given id",
515-
ArgsJSON: `{"action":"start", "server_id": "11111111-1111-1111-1111-111111111111"}`,
515+
ArgsJSON: `{"action":"poweron", "server_id": "11111111-1111-1111-1111-111111111111"}`,
516516
},
517517
},
518518
SeeAlsos: []*core.SeeAlso{

0 commit comments

Comments
 (0)