scaleway · Codelax · Mar 14, 2023 · Mar 14, 2023
@@ -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:

@@ -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 ...]

@@ -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 ...]

@@ -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:

@@ -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

@@ -6,11 +6,11 @@ USAGE:
   scw account project <command>
 
 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

@@ -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 <os-id ...> [arg=value ...]

@@ -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:

@@ -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 ...]

@@ -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 <server-id ...> [arg=value ...]

@@ -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 <server-id ...> [arg=value ...]

@@ -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:

@@ -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 <server-id ...> [arg=value ...]

@@ -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 <server-id ...> [arg=value ...]

@@ -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 ...]

@@ -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 <name ...> [arg=value ...]

@@ -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.
 

@@ -1,16 +1,16 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Create an API key.
+Create an API key. You must specify the `application_id` or the `user_id` and the description. You can also specify the `default_project_id` which is the Project ID of your preferred Project, to use with Object Storage. The `access_key` and `secret_key` values are returned in the response. Note that he secret key is only showed once. Make sure that you copy and store both keys somewhere safe.
 
 USAGE:
   scw iam api-key create [arg=value ...]
 
 ARGS:
-  [application-id]       ID of application principal
-  [user-id]              ID of user principal
+  [application-id]       ID of the application
+  [user-id]              ID of the user
   [expires-at]           Expiration date of the API key
-  [default-project-id]   The default project ID to use with object storage
-  [description]          The description of the API key (max length is 200 chars)
+  [default-project-id]   The default Project ID to use with Object Storage
+  [description]          The description of the API key (max length is 200 characters)
 
 FLAGS:
   -h, --help   help for create

@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Delete an API key.
+Delete an API key. Note that this action is irreversible and cannot be undone. Make sure you update any configurations using the API keys you delete.
 
 USAGE:
   scw iam api-key delete <access-key ...> [arg=value ...]

@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Get an API key.
+Retrive information about an API key, specified by the `access_key` parameter. The API key's details, including either the `user_id` or `application_id` of its bearer are returned in the response. Note that the string value for the `secret_key` is nullable, and therefore is not displayed in the response. The `secret_key` value is only displayed upon API key creation.
 
 USAGE:
   scw iam api-key get <access-key ...> [arg=value ...]

@@ -1,23 +1,23 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-List API keys.
+List API keys. By default, the API keys listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You can define additional parameters for your query such as `editable`, `expired`, `access_key` and `bearer_id`.
 
 USAGE:
   scw iam api-key list [arg=value ...]
 
 ARGS:
   [order-by=created_at_asc]                 Criteria for sorting results (created_at_asc | created_at_desc | updated_at_asc | updated_at_desc | expires_at_asc | expires_at_desc | access_key_asc | access_key_desc)
-  [editable]                                Filter out editable API keys or not
-  [expired]                                 Filter out expired API keys or not
-  [access-key]                              Filter out by access key
-  [description]                             Filter out by description
-  [bearer-id]                               Filter out by bearer ID
-  [bearer-type]                             Filter out by type of bearer (unknown_bearer_type | user | application)
-  organization-id=<retrieved from config>   ID of organization
+  [editable]                                Whether to filter out editable API keys or not
+  [expired]                                 Whether to filter out expired API keys or not
+  [access-key]                              Filter by access key
+  [description]                             Filter by description
+  [bearer-id]                               Filter by bearer ID
+  [bearer-type]                             Filter by type of bearer (unknown_bearer_type | user | application)
+  organization-id=<retrieved from config>   ID of Organization
 
 DEPRECATED ARGS:
-  [application-id]   ID of an application bearer
-  [user-id]          ID of a user bearer
+  [application-id]   ID of application that bears the API key
+  [user-id]          ID of user that bears the API key
 
 FLAGS:
   -h, --help   help for list

@@ -1,13 +1,13 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Update an API key.
+Update the parameters of an API key, including `default_project_id` and `description`.
 
 USAGE:
   scw iam api-key update <access-key ...> [arg=value ...]
 
 ARGS:
   access-key             Access key to update
-  [default-project-id]   The new default project ID to set
+  [default-project-id]   The new default Project ID to set
   [description]          The new description to update
 
 FLAGS:

@@ -1,13 +1,13 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Create a new application.
+Create a new application. You must define the `name` parameter in the request.
 
 USAGE:
   scw iam application create [arg=value ...]
 
 ARGS:
-  name=<generated>    Name of application to create (max length is 64 chars)
-  [description]       Description of application (max length is 200 chars)
+  name=<generated>    Name of the application to create (max length is 64 characters)
+  [description]       Description of the application (max length is 200 characters)
   [organization-id]   Organization ID to use. If none is passed the default organization ID will be used
 
 FLAGS:

@@ -1,12 +1,12 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Delete an application.
+Delete an application. Note that this action is irreversible and will automatically delete the application's API keys. Policies attached to users and applications via this group will no longer apply.
 
 USAGE:
   scw iam application delete <application-id ...> [arg=value ...]
 
 ARGS:
-  application-id   ID of application to delete
+  application-id   ID of the application to delete
 
 FLAGS:
   -h, --help   help for delete

@@ -1,12 +1,12 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Get an existing application.
+Retrieve information about an application, specified by the `application_id` parameter. The application's full details, including `id`, `email`, `organization_id`, `status` and `two_factor_enabled` are returned in the response.
 
 USAGE:
   scw iam application get <application-id ...> [arg=value ...]
 
 ARGS:
-  application-id   ID of application to find
+  application-id   ID of the application to find
 
 FLAGS:
   -h, --help   help for get

@@ -1,16 +1,16 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-List applications of an organization.
+List the applications of an Organization. By default, the applications listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You must define the `organization_id` in the query path of your request. You can also define additional parameters for your query such as `application_ids`.
 
 USAGE:
   scw iam application list [arg=value ...]
 
 ARGS:
   [order-by=created_at_asc]                 Criteria for sorting results (created_at_asc | created_at_desc | updated_at_asc | updated_at_desc | name_asc | name_desc)
-  [name]                                    Name of application to filter
-  [editable]                                Filter out editable applications or not
-  [application-ids.{index}]                 Filter out by a list of ID
-  organization-id=<retrieved from config>   ID of organization to filter
+  [name]                                    Name of the application to filter
+  [editable]                                Whether to filter out editable applications or not
+  [application-ids.{index}]                 Filter by list of IDs
+  organization-id=<retrieved from config>   ID of the Organization to filter
 
 FLAGS:
   -h, --help   help for list

@@ -1,14 +1,14 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Update an existing application.
+Update the parameters of an application, including `name` and `description`.
 
 USAGE:
   scw iam application update <application-id ...> [arg=value ...]
 
 ARGS:
-  application-id   ID of application to update
-  [name]           New name of application (max length is 64 chars)
-  [description]    New description of application (max length is 200 chars)
+  application-id   ID of the application to update
+  [name]           New name for the application (max length is 64 chars)
+  [description]    New description for the application (max length is 200 chars)
 
 FLAGS:
   -h, --help   help for update

@@ -8,9 +8,9 @@ USAGE:
 AVAILABLE COMMANDS:
   create      Create a new application
   delete      Delete an application
-  get         Get an existing application
-  list        List applications of an organization
-  update      Update an existing application
+  get         Get a given application
+  list        List applications of an Organization
+  update      Update an application
 
 FLAGS:
   -h, --help   help for application

@@ -1,12 +1,12 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Add a user of an application to a group.
+Add a user or an application to a group. You can specify a `user_id` and and `application_id` in the body of your request. Note that you can only add one of each per request.
 
 USAGE:
   scw iam group add-member <group-id ...> [arg=value ...]
 
 ARGS:
-  group-id           ID of group
+  group-id           ID of the group
   [user-id]          ID of the user to add
   [application-id]   ID of the application to add