docs: update products documentation (#525)

Author: scaleway-bot

packages/clients/src/api/account/v2/api.gen.ts

@@ -29,12 +29,12 @@ const jsonContentHeaders = {
 /**
  * Account API.
  *
- * This API allows you to manage projects.
+ * User related data. This API allows you to manage projects.
  */
 export class API extends ParentAPI {
   /**
-   * Generate a new Project for an Organization, specifying its configuration
-   * including name and description.
+   * Create a new Project for an Organization. Generate a new Project for an
+   * Organization, specifying its configuration including name and description.
    *
    * @param request - The request {@link CreateProjectRequest}
    * @returns A Promise of Project
@@ -79,10 +79,10 @@ export class API extends ParentAPI {
     )
 
   /**
-   * 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.
+   * List all Projects of an Organization. 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.
    *
    * @param request - The request {@link ListProjectsRequest}
    * @returns A Promise of ListProjectsResponse
@@ -91,9 +91,9 @@ export class API extends ParentAPI {
     enrichForPagination('projects', this.pageOfListProjects, request)
 
   /**
-   * 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.
+   * Get an existing 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.
    *
    * @param request - The request {@link GetProjectRequest}
    * @returns A Promise of Project
@@ -111,10 +111,10 @@ export class API extends ParentAPI {
     )
 
   /**
-   * 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.
+   * Delete an existing 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.
    *
    * @param request - The request {@link DeleteProjectRequest}
    */
@@ -128,8 +128,8 @@ export class API extends ParentAPI {
     })
 
   /**
-   * Update the parameters of an existing Project, specified by its Project ID.
-   * These parameters include the name and description.
+   * Update Project. Update the parameters of an existing Project, specified by
+   * its Project ID. These parameters include the name and description.
    *
    * @param request - The request {@link UpdateProjectRequest}
    * @returns A Promise of Project

packages/clients/src/api/applesilicon/v1alpha1/api.gen.ts

@@ -46,8 +46,8 @@ const jsonContentHeaders = {
 /**
  * Apple silicon.
  *
- * Scaleway Apple silicon as-a-Service is built using the latest generation of
- * Apple Mac mini hardware (fifth generation).
+ * Apple Mac mini as a service. 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
@@ -69,9 +69,9 @@ export class API extends ParentAPI {
   public static readonly LOCALITIES: Zone[] = ['fr-par-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`.
+   * List server types. 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`.
    *
    * @param request - The request {@link ListServerTypesRequest}
    * @returns A Promise of ListServerTypesResponse
@@ -89,7 +89,7 @@ export class API extends ParentAPI {
     )
 
   /**
-   * Get a server technical details.
+   * Get a server type. Get a server technical details.
    *
    * @param request - The request {@link GetServerTypeRequest}
    * @returns A Promise of ServerType
@@ -107,8 +107,8 @@ export class API extends ParentAPI {
     )
 
   /**
-   * Create a new server in the targeted zone, specifying its configuration
-   * including name and type.
+   * Create a server. Create a new server in the targeted zone, specifying its
+   * configuration including name and type.
    *
    * @param request - The request {@link CreateServerRequest}
    * @returns A Promise of Server
@@ -152,9 +152,9 @@ export class API extends ParentAPI {
     )
 
   /**
-   * 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.
+   * 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.
    *
    * @param request - The request {@link ListServersRequest}
    * @returns A Promise of ListServersResponse
@@ -184,8 +184,9 @@ export class API extends ParentAPI {
     )
 
   /**
-   * List all Operating System (OS). The response will include the total number
-   * of OS as well as their associated IDs, names and labels.
+   * 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.
    *
    * @param request - The request {@link ListOSRequest}
    * @returns A Promise of ListOSResponse
@@ -194,8 +195,8 @@ export class API extends ParentAPI {
     enrichForPagination('os', this.pageOfListOS, request)
 
   /**
-   * Get an Operating System (OS). The response will include the OS's unique ID
-   * as well as its name and label.
+   * 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.
    *
    * @param request - The request {@link GetOSRequest}
    * @returns A Promise of OS
@@ -213,9 +214,9 @@ export class API extends ParentAPI {
     )
 
   /**
-   * 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.
+   * 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.
    *
    * @param request - The request {@link GetServerRequest}
    * @returns A Promise of Server
@@ -253,8 +254,8 @@ export class API extends ParentAPI {
     )
 
   /**
-   * Update the parameters of an existing Apple silicon server, specified by its
-   * server ID.
+   * Update a server. Update the parameters of an existing Apple silicon server,
+   * specified by its server ID.
    *
    * @param request - The request {@link UpdateServerRequest}
    * @returns A Promise of Server
@@ -276,10 +277,10 @@ export class API extends ParentAPI {
     )
 
   /**
-   * 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.
+   * 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.
    *
    * @param request - The request {@link DeleteServerRequest}
    */
@@ -293,7 +294,8 @@ export class API extends ParentAPI {
     })
 
   /**
-   * Reboot an existing Apple silicon server, specified by its server ID.
+   * Reboot a server. Reboot an existing Apple silicon server, specified by its
+   * server ID.
    *
    * @param request - The request {@link RebootServerRequest}
    * @returns A Promise of Server
@@ -313,10 +315,10 @@ export class API extends ParentAPI {
     )
 
   /**
-   * 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).
+   * 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).
    *
    * @param request - The request {@link ReinstallServerRequest}
    * @returns A Promise of Server

packages/clients/src/api/applesilicon/v1alpha1/types.gen.ts

@@ -98,7 +98,10 @@ export interface ServerType {
   memory?: ServerTypeMemory
   /** Current stock. */
   stock: ServerTypeStock
-  /** Minimum duration of the lease in seconds (example. 3.4s). */
+  /**
+   * Minimum duration of the lease in seconds. Minimum duration of the lease in
+   * seconds (example. 3.4s).
+   */
   minimumLeaseDuration?: string
 }