From 801d9e7eca4fb9ea746f09177fae6d1a9abb2549 Mon Sep 17 00:00:00 2001 From: scaleway-bot Date: Tue, 14 Mar 2023 15:27:48 +0000 Subject: [PATCH] feat: update generated APIs --- ...-usage-account-project-create-usage.golden | 6 +-- ...-usage-account-project-delete-usage.golden | 2 +- ...all-usage-account-project-get-usage.golden | 2 +- ...ll-usage-account-project-list-usage.golden | 8 ++-- ...-usage-account-project-update-usage.golden | 6 +-- ...est-all-usage-account-project-usage.golden | 10 ++--- ...ll-usage-apple-silicon-os-get-usage.golden | 2 +- ...l-usage-apple-silicon-os-list-usage.golden | 6 +-- ...e-apple-silicon-server-create-usage.golden | 2 +- ...e-apple-silicon-server-delete-usage.golden | 2 +- ...sage-apple-silicon-server-get-usage.golden | 2 +- ...age-apple-silicon-server-list-usage.golden | 8 ++-- ...e-apple-silicon-server-reboot-usage.golden | 2 +- ...pple-silicon-server-reinstall-usage.golden | 2 +- ...pple-silicon-server-type-list-usage.golden | 2 +- ...e-apple-silicon-server-update-usage.golden | 2 +- .../test-all-usage-apple-silicon-usage.golden | 2 +- docs/commands/account.md | 44 +++++++++---------- docs/commands/apple-silicon.md | 32 +++++++------- go.mod | 2 +- go.sum | 4 +- .../applesilicon/v1alpha1/applesilicon_cli.go | 32 +++++++------- 22 files changed, 90 insertions(+), 90 deletions(-) diff --git a/cmd/scw/testdata/test-all-usage-account-project-create-usage.golden b/cmd/scw/testdata/test-all-usage-account-project-create-usage.golden index d000ed69d2..33ca4fd3c9 100644 --- a/cmd/scw/testdata/test-all-usage-account-project-create-usage.golden +++ b/cmd/scw/testdata/test-all-usage-account-project-create-usage.golden @@ -1,13 +1,13 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Create project. +Generate a new Project for an Organization, specifying its configuration including name and description. USAGE: scw account project create [arg=value ...] ARGS: - [name] The name of the project - [description] The description of the project + [name] Name of the Project + [description] Description of the Project [organization-id] Organization ID to use. If none is passed the default organization ID will be used FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-account-project-delete-usage.golden b/cmd/scw/testdata/test-all-usage-account-project-delete-usage.golden index 13bffbff9e..60ba230c6d 100644 --- a/cmd/scw/testdata/test-all-usage-account-project-delete-usage.golden +++ b/cmd/scw/testdata/test-all-usage-account-project-delete-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Delete project. +Delete an existing Project, specified by its Project ID. The Project needs to be empty (meaning there are no resources left in it) to be deleted effectively. Note that deleting a Project is permanent, and cannot be undone. USAGE: scw account project delete [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-account-project-get-usage.golden b/cmd/scw/testdata/test-all-usage-account-project-get-usage.golden index c63e207218..e32a50be2a 100644 --- a/cmd/scw/testdata/test-all-usage-account-project-get-usage.golden +++ b/cmd/scw/testdata/test-all-usage-account-project-get-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Get project. +Retrieve information about an existing Project, specified by its Project ID. Its full details, including ID, name and description, are returned in the response object. USAGE: scw account project get [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-account-project-list-usage.golden b/cmd/scw/testdata/test-all-usage-account-project-list-usage.golden index 0dd6617b70..caeb4ed68d 100644 --- a/cmd/scw/testdata/test-all-usage-account-project-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-account-project-list-usage.golden @@ -1,14 +1,14 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -List projects. +List all Projects of an Organization. The response will include the total number of Projects as well as their associated Organizations, names and IDs. Other information include the creation and update date of the Project. USAGE: scw account project list [arg=value ...] ARGS: - [name] The name of the project - [order-by] The sort order of the returned projects (created_at_asc | created_at_desc | name_asc | name_desc) - [project-ids.{index}] Filter out by a list of project ID + [name] Name of the Project + [order-by] Sort order of the returned Projects (created_at_asc | created_at_desc | name_asc | name_desc) + [project-ids.{index}] Project IDs to filter for. The results will be limited to any Projects with an ID in this array [organization-id] Organization ID to use. If none is passed the default organization ID will be used FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-account-project-update-usage.golden b/cmd/scw/testdata/test-all-usage-account-project-update-usage.golden index 1c279bac6e..c3a6acdd0a 100644 --- a/cmd/scw/testdata/test-all-usage-account-project-update-usage.golden +++ b/cmd/scw/testdata/test-all-usage-account-project-update-usage.golden @@ -1,14 +1,14 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Update project. +Update the parameters of an existing Project, specified by its Project ID. These parameters include the name and description. USAGE: scw account project update [arg=value ...] ARGS: [project-id] Project ID to use. If none is passed the default project ID will be used - [name] The name of the project - [description] The description of the project + [name] Name of the Project + [description] Description of the Project FLAGS: -h, --help help for update diff --git a/cmd/scw/testdata/test-all-usage-account-project-usage.golden b/cmd/scw/testdata/test-all-usage-account-project-usage.golden index 2f0d6a2a41..fb5cde849a 100644 --- a/cmd/scw/testdata/test-all-usage-account-project-usage.golden +++ b/cmd/scw/testdata/test-all-usage-account-project-usage.golden @@ -6,11 +6,11 @@ USAGE: scw account project AVAILABLE COMMANDS: - create Create project - delete Delete project - get Get project - list List projects - update Update project + create Create a new Project for an Organization + delete Delete an existing Project + get Get an existing Project + list List all Projects of an Organization + update Update Project FLAGS: -h, --help help for project diff --git a/cmd/scw/testdata/test-all-usage-apple-silicon-os-get-usage.golden b/cmd/scw/testdata/test-all-usage-apple-silicon-os-get-usage.golden index cbddc61009..070b906ef3 100644 --- a/cmd/scw/testdata/test-all-usage-apple-silicon-os-get-usage.golden +++ b/cmd/scw/testdata/test-all-usage-apple-silicon-os-get-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Get an Operating System (OS). +Get an Operating System (OS). The response will include the OS's unique ID as well as its name and label. USAGE: scw apple-silicon os get [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-apple-silicon-os-list-usage.golden b/cmd/scw/testdata/test-all-usage-apple-silicon-os-list-usage.golden index 20e2805df8..782891f300 100644 --- a/cmd/scw/testdata/test-all-usage-apple-silicon-os-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-apple-silicon-os-list-usage.golden @@ -1,13 +1,13 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -List all Operating System (OS). +List all Operating System (OS). The response will include the total number of OS as well as their associated IDs, names and labels. USAGE: scw apple-silicon os list [arg=value ...] ARGS: - [server-type] List of compatible server type - [name] Filter os by name (for eg. "11.1" will return "11.1.2" and "11.1" but not "12") + [server-type] List of compatible server types + [name] Filter OS by name (note that "11.1" will return "11.1.2" and "11.1" but not "12")) [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-3 | all) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-apple-silicon-server-create-usage.golden b/cmd/scw/testdata/test-all-usage-apple-silicon-server-create-usage.golden index f22d5bbcea..87750a3378 100644 --- a/cmd/scw/testdata/test-all-usage-apple-silicon-server-create-usage.golden +++ b/cmd/scw/testdata/test-all-usage-apple-silicon-server-create-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Create a server. +Create a new server in the targeted zone, specifying its configuration including name and type. USAGE: scw apple-silicon server create [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-apple-silicon-server-delete-usage.golden b/cmd/scw/testdata/test-all-usage-apple-silicon-server-delete-usage.golden index 4f4fef3ac8..3fc28af370 100644 --- a/cmd/scw/testdata/test-all-usage-apple-silicon-server-delete-usage.golden +++ b/cmd/scw/testdata/test-all-usage-apple-silicon-server-delete-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Delete a server. +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. USAGE: scw apple-silicon server delete [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-apple-silicon-server-get-usage.golden b/cmd/scw/testdata/test-all-usage-apple-silicon-server-get-usage.golden index 31f2f5b0d6..bc8866dfa5 100644 --- a/cmd/scw/testdata/test-all-usage-apple-silicon-server-get-usage.golden +++ b/cmd/scw/testdata/test-all-usage-apple-silicon-server-get-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Get a server. +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. USAGE: scw apple-silicon server get [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-apple-silicon-server-list-usage.golden b/cmd/scw/testdata/test-all-usage-apple-silicon-server-list-usage.golden index 39d3fed8b1..fcbf0fccd7 100644 --- a/cmd/scw/testdata/test-all-usage-apple-silicon-server-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-apple-silicon-server-list-usage.golden @@ -1,14 +1,14 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -List all servers. +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. USAGE: scw apple-silicon server list [arg=value ...] ARGS: - [order-by] The sort order of the returned servers (created_at_asc | created_at_desc) - [project-id] List only servers of this project ID - [organization-id] List only servers of this organization ID + [order-by] Sort order of the returned servers (created_at_asc | created_at_desc) + [project-id] Only list servers of this project ID + [organization-id] Only list servers of this Organization ID [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-3 | all) FLAGS: diff --git a/cmd/scw/testdata/test-all-usage-apple-silicon-server-reboot-usage.golden b/cmd/scw/testdata/test-all-usage-apple-silicon-server-reboot-usage.golden index 89077f2231..eb2a99bec0 100644 --- a/cmd/scw/testdata/test-all-usage-apple-silicon-server-reboot-usage.golden +++ b/cmd/scw/testdata/test-all-usage-apple-silicon-server-reboot-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Reboot a server. +Reboot an existing Apple silicon server, specified by its server ID. USAGE: scw apple-silicon server reboot [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-apple-silicon-server-reinstall-usage.golden b/cmd/scw/testdata/test-all-usage-apple-silicon-server-reinstall-usage.golden index 7ada701b1f..d10b268554 100644 --- a/cmd/scw/testdata/test-all-usage-apple-silicon-server-reinstall-usage.golden +++ b/cmd/scw/testdata/test-all-usage-apple-silicon-server-reinstall-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Reinstall a server. +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). USAGE: scw apple-silicon server reinstall [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-apple-silicon-server-type-list-usage.golden b/cmd/scw/testdata/test-all-usage-apple-silicon-server-type-list-usage.golden index 8e52343351..37fbe942a2 100644 --- a/cmd/scw/testdata/test-all-usage-apple-silicon-server-type-list-usage.golden +++ b/cmd/scw/testdata/test-all-usage-apple-silicon-server-type-list-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -List all server types technical details. +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`. USAGE: scw apple-silicon server-type list [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-apple-silicon-server-update-usage.golden b/cmd/scw/testdata/test-all-usage-apple-silicon-server-update-usage.golden index d56f83bcde..752bcc9873 100644 --- a/cmd/scw/testdata/test-all-usage-apple-silicon-server-update-usage.golden +++ b/cmd/scw/testdata/test-all-usage-apple-silicon-server-update-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Update a server. +Update the parameters of an existing Apple silicon server, specified by its server ID. USAGE: scw apple-silicon server update [arg=value ...] diff --git a/cmd/scw/testdata/test-all-usage-apple-silicon-usage.golden b/cmd/scw/testdata/test-all-usage-apple-silicon-usage.golden index 7a2fc8ac4e..827c4d0661 100644 --- a/cmd/scw/testdata/test-all-usage-apple-silicon-usage.golden +++ b/cmd/scw/testdata/test-all-usage-apple-silicon-usage.golden @@ -1,6 +1,6 @@ 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲 πŸŸ₯πŸŸ₯πŸŸ₯ STDERR️️ πŸŸ₯πŸŸ₯πŸŸ₯️ -Scaleway Apple silicon M1 as-a-Service is built using the latest generation of Apple Mac mini hardware (fifth generation). +Scaleway Apple silicon as-a-Service is built using the latest generation of Apple Mac mini hardware (fifth generation). These dedicated Mac mini M1s are designed for developing, building, testing, and signing applications for Apple devices, including iPhones, iPads, Mac computers and much more. diff --git a/docs/commands/account.md b/docs/commands/account.md index 1ceae6b494..df0095feab 100644 --- a/docs/commands/account.md +++ b/docs/commands/account.md @@ -3,11 +3,11 @@ This API allows you to manage projects. - [Project management commands](#project-management-commands) - - [Create project](#create-project) - - [Delete project](#delete-project) - - [Get project](#get-project) - - [List projects](#list-projects) - - [Update project](#update-project) + - [Create a new Project for an Organization](#create-a-new-project-for-an-organization) + - [Delete an existing Project](#delete-an-existing-project) + - [Get an existing Project](#get-an-existing-project) + - [List all Projects of an Organization](#list-all-projects-of-an-organization) + - [Update Project](#update-project) ## Project management commands @@ -15,9 +15,9 @@ This API allows you to manage projects. Project management commands. -### Create project +### Create a new Project for an Organization -Create project. +Generate a new Project for an Organization, specifying its configuration including name and description. **Usage:** @@ -30,15 +30,15 @@ scw account project create [arg=value ...] | Name | | Description | |------|---|-------------| -| name | | The name of the project | -| description | | The description of the project | +| name | | Name of the Project | +| description | | Description of the Project | | organization-id | | Organization ID to use. If none is passed the default organization ID will be used | -### Delete project +### Delete an existing Project -Delete project. +Delete an existing Project, specified by its Project ID. The Project needs to be empty (meaning there are no resources left in it) to be deleted effectively. Note that deleting a Project is permanent, and cannot be undone. **Usage:** @@ -55,9 +55,9 @@ scw account project delete [arg=value ...] -### Get project +### Get an existing Project -Get project. +Retrieve information about an existing Project, specified by its Project ID. Its full details, including ID, name and description, are returned in the response object. **Usage:** @@ -74,9 +74,9 @@ scw account project get [arg=value ...] -### List projects +### List all Projects of an Organization -List projects. +List all Projects of an Organization. The response will include the total number of Projects as well as their associated Organizations, names and IDs. Other information include the creation and update date of the Project. **Usage:** @@ -89,16 +89,16 @@ scw account project list [arg=value ...] | Name | | Description | |------|---|-------------| -| name | | The name of the project | -| order-by | One of: `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc` | The sort order of the returned projects | -| project-ids.{index} | | Filter out by a list of project ID | +| name | | Name of the Project | +| order-by | One of: `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc` | Sort order of the returned Projects | +| project-ids.{index} | | Project IDs to filter for. The results will be limited to any Projects with an ID in this array | | organization-id | | Organization ID to use. If none is passed the default organization ID will be used | -### Update project +### Update Project -Update project. +Update the parameters of an existing Project, specified by its Project ID. These parameters include the name and description. **Usage:** @@ -112,8 +112,8 @@ scw account project update [arg=value ...] | Name | | Description | |------|---|-------------| | project-id | | Project ID to use. If none is passed the default project ID will be used | -| name | | The name of the project | -| description | | The description of the project | +| name | | Name of the Project | +| description | | Description of the Project | diff --git a/docs/commands/apple-silicon.md b/docs/commands/apple-silicon.md index 43e2d60a1d..5e238ee173 100644 --- a/docs/commands/apple-silicon.md +++ b/docs/commands/apple-silicon.md @@ -1,6 +1,6 @@ # Documentation for `scw apple-silicon` -Scaleway Apple silicon M1 as-a-Service is built using the latest generation of Apple Mac mini hardware (fifth generation). +Scaleway Apple silicon as-a-Service is built using the latest generation of Apple Mac mini hardware (fifth generation). These dedicated Mac mini M1s are designed for developing, building, testing, and signing applications for Apple devices, including iPhones, iPads, Mac computers and much more. @@ -37,7 +37,7 @@ OS management commands ### Get an Operating System (OS) -Get an Operating System (OS). +Get an Operating System (OS). The response will include the OS's unique ID as well as its name and label. **Usage:** @@ -57,7 +57,7 @@ scw apple-silicon os get [arg=value ...] ### List all Operating System (OS) -List all Operating System (OS). +List all Operating System (OS). The response will include the total number of OS as well as their associated IDs, names and labels. **Usage:** @@ -70,8 +70,8 @@ scw apple-silicon os list [arg=value ...] | Name | | Description | |------|---|-------------| -| server-type | | List of compatible server type | -| name | | Filter os by name (for eg. "11.1" will return "11.1.2" and "11.1" but not "12") | +| server-type | | List of compatible server types | +| name | | Filter OS by name (note that "11.1" will return "11.1.2" and "11.1" but not "12")) | | zone | Default: `fr-par-1`
One of: `fr-par-3`, `all` | Zone to target. If none is passed will use default zone from the config | @@ -83,7 +83,7 @@ Apple silicon management commands ### Create a server -Create a server. +Create a new server in the targeted zone, specifying its configuration including name and type. **Usage:** @@ -105,7 +105,7 @@ scw apple-silicon server create [arg=value ...] ### Delete a server -Delete a server. +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. **Usage:** @@ -125,7 +125,7 @@ scw apple-silicon server delete [arg=value ...] ### Get a server -Get a server. +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. **Usage:** @@ -145,7 +145,7 @@ scw apple-silicon server get [arg=value ...] ### List all servers -List all servers. +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. **Usage:** @@ -158,16 +158,16 @@ scw apple-silicon server list [arg=value ...] | Name | | Description | |------|---|-------------| -| order-by | One of: `created_at_asc`, `created_at_desc` | The sort order of the returned servers | -| project-id | | List only servers of this project ID | -| organization-id | | List only servers of this organization ID | +| order-by | One of: `created_at_asc`, `created_at_desc` | Sort order of the returned servers | +| project-id | | Only list servers of this project ID | +| organization-id | | Only list servers of this Organization ID | | zone | Default: `fr-par-1`
One of: `fr-par-3`, `all` | Zone to target. If none is passed will use default zone from the config | ### Reboot a server -Reboot a server. +Reboot an existing Apple silicon server, specified by its server ID. **Usage:** @@ -187,7 +187,7 @@ scw apple-silicon server reboot [arg=value ...] ### Reinstall a server -Reinstall a server. +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). **Usage:** @@ -230,7 +230,7 @@ scw apple-silicon server ssh [arg=value ...] ### Update a server -Update a server. +Update the parameters of an existing Apple silicon server, specified by its server ID. **Usage:** @@ -306,7 +306,7 @@ scw apple-silicon server-type get [arg=value ...] ### List server types -List all server types technical details. +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`. **Usage:** diff --git a/go.mod b/go.mod index 464996fe37..2d77f4760a 100644 --- a/go.mod +++ b/go.mod @@ -19,7 +19,7 @@ require ( github.com/kubernetes-client/go-base v0.0.0-20190205182333-3d0e39759d98 github.com/mattn/go-colorable v0.1.13 github.com/mattn/go-isatty v0.0.17 - github.com/scaleway/scaleway-sdk-go v1.0.0-beta.14.0.20230310155856-7a2786489bc6 + github.com/scaleway/scaleway-sdk-go v1.0.0-beta.14.0.20230314101523-398c37802c41 github.com/spf13/cobra v1.6.1 github.com/spf13/pflag v1.0.5 github.com/stretchr/testify v1.8.2 diff --git a/go.sum b/go.sum index 76be72212c..d6cfc3cd51 100644 --- a/go.sum +++ b/go.sum @@ -72,8 +72,8 @@ github.com/pkg/term v1.1.0/go.mod h1:E25nymQcrSllhX42Ok8MRm1+hyBdHY0dCeiKZ9jpNGw github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= -github.com/scaleway/scaleway-sdk-go v1.0.0-beta.14.0.20230310155856-7a2786489bc6 h1:bAqxZt/1FAD/M4XLqWYHySz5kNcoQ7Mrdo7imgWAyaQ= -github.com/scaleway/scaleway-sdk-go v1.0.0-beta.14.0.20230310155856-7a2786489bc6/go.mod h1:fCa7OJZ/9DRTnOKmxvT6pn+LPWUptQAmHF/SBJUGEcg= +github.com/scaleway/scaleway-sdk-go v1.0.0-beta.14.0.20230314101523-398c37802c41 h1:D9rWQCzAaXoBOEQTnw+x5YI1JLZRj/ccKtT4u5DCC1E= +github.com/scaleway/scaleway-sdk-go v1.0.0-beta.14.0.20230314101523-398c37802c41/go.mod h1:fCa7OJZ/9DRTnOKmxvT6pn+LPWUptQAmHF/SBJUGEcg= github.com/sergi/go-diff v1.2.0 h1:XU+rvMAioB0UC3q1MFrIQy4Vo5/4VsRDQQXHsEya6xQ= github.com/sergi/go-diff v1.2.0/go.mod h1:STckp+ISIX8hZLjrqAeVduY0gWCT9IjLuqbuNXdaHfM= github.com/spf13/cobra v1.6.1 h1:o94oiPyS4KD1mPy2fmcYYHHfCxLqYjJOhGsCHFZtEzA= diff --git a/internal/namespaces/applesilicon/v1alpha1/applesilicon_cli.go b/internal/namespaces/applesilicon/v1alpha1/applesilicon_cli.go index 3ae7919a5c..de6ec82348 100644 --- a/internal/namespaces/applesilicon/v1alpha1/applesilicon_cli.go +++ b/internal/namespaces/applesilicon/v1alpha1/applesilicon_cli.go @@ -39,7 +39,7 @@ func GetGeneratedCommands() *core.Commands { func appleSiliconRoot() *core.Command { return &core.Command{ Short: `Apple silicon API`, - Long: `Scaleway Apple silicon M1 as-a-Service is built using the latest generation of Apple Mac mini hardware (fifth generation). + Long: `Scaleway Apple silicon as-a-Service is built using the latest generation of Apple Mac mini hardware (fifth generation). These dedicated Mac mini M1s are designed for developing, building, testing, and signing applications for Apple devices, including iPhones, iPads, Mac computers and much more. @@ -84,7 +84,7 @@ func appleSiliconServerType() *core.Command { func appleSiliconServerTypeList() *core.Command { return &core.Command{ Short: `List server types`, - Long: `List all server types technical details.`, + Long: `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` + "`" + `.`, Namespace: "apple-silicon", Resource: "server-type", Verb: "list", @@ -137,7 +137,7 @@ func appleSiliconServerTypeGet() *core.Command { func appleSiliconServerCreate() *core.Command { return &core.Command{ Short: `Create a server`, - Long: `Create a server.`, + Long: `Create a new server in the targeted zone, specifying its configuration including name and type.`, Namespace: "apple-silicon", Resource: "server", Verb: "create", @@ -177,7 +177,7 @@ func appleSiliconServerCreate() *core.Command { func appleSiliconServerList() *core.Command { return &core.Command{ Short: `List all servers`, - Long: `List all servers.`, + Long: `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.`, Namespace: "apple-silicon", Resource: "server", Verb: "list", @@ -186,7 +186,7 @@ func appleSiliconServerList() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "order-by", - Short: `The sort order of the returned servers`, + Short: `Sort order of the returned servers`, Required: false, Deprecated: false, Positional: false, @@ -194,14 +194,14 @@ func appleSiliconServerList() *core.Command { }, { Name: "project-id", - Short: `List only servers of this project ID`, + Short: `Only list servers of this project ID`, Required: false, Deprecated: false, Positional: false, }, { Name: "organization-id", - Short: `List only servers of this organization ID`, + Short: `Only list servers of this Organization ID`, Required: false, Deprecated: false, Positional: false, @@ -231,7 +231,7 @@ func appleSiliconServerList() *core.Command { func appleSiliconOsList() *core.Command { return &core.Command{ Short: `List all Operating System (OS)`, - Long: `List all Operating System (OS).`, + Long: `List all Operating System (OS). The response will include the total number of OS as well as their associated IDs, names and labels.`, Namespace: "apple-silicon", Resource: "os", Verb: "list", @@ -240,14 +240,14 @@ func appleSiliconOsList() *core.Command { ArgSpecs: core.ArgSpecs{ { Name: "server-type", - Short: `List of compatible server type`, + Short: `List of compatible server types`, Required: false, Deprecated: false, Positional: false, }, { Name: "name", - Short: `Filter os by name (for eg. "11.1" will return "11.1.2" and "11.1" but not "12")`, + Short: `Filter OS by name (note that "11.1" will return "11.1.2" and "11.1" but not "12"))`, Required: false, Deprecated: false, Positional: false, @@ -277,7 +277,7 @@ func appleSiliconOsList() *core.Command { func appleSiliconOsGet() *core.Command { return &core.Command{ Short: `Get an Operating System (OS)`, - Long: `Get an Operating System (OS).`, + Long: `Get an Operating System (OS). The response will include the OS's unique ID as well as its name and label.`, Namespace: "apple-silicon", Resource: "os", Verb: "get", @@ -307,7 +307,7 @@ func appleSiliconOsGet() *core.Command { func appleSiliconServerGet() *core.Command { return &core.Command{ Short: `Get a server`, - Long: `Get a server.`, + Long: `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.`, Namespace: "apple-silicon", Resource: "server", Verb: "get", @@ -337,7 +337,7 @@ func appleSiliconServerGet() *core.Command { func appleSiliconServerUpdate() *core.Command { return &core.Command{ Short: `Update a server`, - Long: `Update a server.`, + Long: `Update the parameters of an existing Apple silicon server, specified by its server ID.`, Namespace: "apple-silicon", Resource: "server", Verb: "update", @@ -374,7 +374,7 @@ func appleSiliconServerUpdate() *core.Command { func appleSiliconServerDelete() *core.Command { return &core.Command{ Short: `Delete a server`, - Long: `Delete a server.`, + Long: `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.`, Namespace: "apple-silicon", Resource: "server", Verb: "delete", @@ -410,7 +410,7 @@ func appleSiliconServerDelete() *core.Command { func appleSiliconServerReboot() *core.Command { return &core.Command{ Short: `Reboot a server`, - Long: `Reboot a server.`, + Long: `Reboot an existing Apple silicon server, specified by its server ID.`, Namespace: "apple-silicon", Resource: "server", Verb: "reboot", @@ -440,7 +440,7 @@ func appleSiliconServerReboot() *core.Command { func appleSiliconServerReinstall() *core.Command { return &core.Command{ Short: `Reinstall a server`, - Long: `Reinstall a server.`, + Long: `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).`, Namespace: "apple-silicon", Resource: "server", Verb: "reinstall",