Skip to content

Commit b319b7e

Browse files
authored
docs(apple): reworked apple silicon api doc (#2867)
1 parent 529d481 commit b319b7e

13 files changed

+48
-48
lines changed

β€Žcmd/scw/testdata/test-all-usage-apple-silicon-os-get-usage.goldenβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️
3-
Get an Operating System (OS).
3+
Get an Operating System (OS). The response will include the OS's unique ID as well as its name and label.
44

55
USAGE:
66
scw apple-silicon os get <os-id ...> [arg=value ...]

β€Žcmd/scw/testdata/test-all-usage-apple-silicon-os-list-usage.goldenβ€Ž

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️
3-
List all Operating System (OS).
3+
List all Operating System (OS). The response will include the total number of OS as well as their associated IDs, names and labels.
44

55
USAGE:
66
scw apple-silicon os list [arg=value ...]
77

88
ARGS:
9-
[server-type] List of compatible server type
10-
[name] Filter os by name (for eg. "11.1" will return "11.1.2" and "11.1" but not "12")
9+
[server-type] List of compatible server types
10+
[name] Filter OS by name (note that "11.1" will return "11.1.2" and "11.1" but not "12"))
1111
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-3 | all)
1212

1313
FLAGS:

β€Žcmd/scw/testdata/test-all-usage-apple-silicon-server-create-usage.goldenβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️
3-
Create a server.
3+
Create a new server in the targeted zone, specifying its configuration including name and type.
44

55
USAGE:
66
scw apple-silicon server create [arg=value ...]

β€Žcmd/scw/testdata/test-all-usage-apple-silicon-server-delete-usage.goldenβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️
3-
Delete a server.
3+
Delete an existing Apple silicon server, specified by its server ID. Deleting a server is permanent, and cannot be undone. Note that the minimum allocation period for Apple silicon-as-a-service is 24 hours, meaning you cannot delete your server prior to that.
44

55
USAGE:
66
scw apple-silicon server delete <server-id ...> [arg=value ...]

β€Žcmd/scw/testdata/test-all-usage-apple-silicon-server-get-usage.goldenβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️
3-
Get a server.
3+
Retrieve information about an existing Apple silicon server, specified by its server ID. Its full details, including name, status and IP address, are returned in the response object.
44

55
USAGE:
66
scw apple-silicon server get <server-id ...> [arg=value ...]

β€Žcmd/scw/testdata/test-all-usage-apple-silicon-server-list-usage.goldenβ€Ž

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️
3-
List all servers.
3+
List all servers in the specified zone. By default, returned servers in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field.
44

55
USAGE:
66
scw apple-silicon server list [arg=value ...]
77

88
ARGS:
9-
[order-by] The sort order of the returned servers (created_at_asc | created_at_desc)
10-
[project-id] List only servers of this project ID
11-
[organization-id] List only servers of this organization ID
9+
[order-by] Sort order of the returned servers (created_at_asc | created_at_desc)
10+
[project-id] Only list servers of this project ID
11+
[organization-id] Only list servers of this Organization ID
1212
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-3 | all)
1313

1414
FLAGS:

β€Žcmd/scw/testdata/test-all-usage-apple-silicon-server-reboot-usage.goldenβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️
3-
Reboot a server.
3+
Reboot an existing Apple silicon server, specified by its server ID.
44

55
USAGE:
66
scw apple-silicon server reboot <server-id ...> [arg=value ...]

β€Žcmd/scw/testdata/test-all-usage-apple-silicon-server-reinstall-usage.goldenβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️
3-
Reinstall a server.
3+
Reinstall an existing Apple silicon server (specified by its server ID) from a new image (OS). All the data on the disk is deleted and all configuration is reset to the defailt configuration values of the image (OS).
44

55
USAGE:
66
scw apple-silicon server reinstall <server-id ...> [arg=value ...]

β€Žcmd/scw/testdata/test-all-usage-apple-silicon-server-type-list-usage.goldenβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️
3-
List all server types technical details.
3+
List all technical details about Apple silicon server types available in the specified zone. Since there is only one Availability Zone for Apple silicon servers, the targeted value is `fr-par-3`.
44

55
USAGE:
66
scw apple-silicon server-type list [arg=value ...]

β€Žcmd/scw/testdata/test-all-usage-apple-silicon-server-update-usage.goldenβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️
3-
Update a server.
3+
Update the parameters of an existing Apple silicon server, specified by its server ID.
44

55
USAGE:
66
scw apple-silicon server update <name ...> [arg=value ...]

0 commit comments

Comments
Β (0)