docs(account): revamp of the documentation (#519)

Author: scaleway-bot

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

@@ -33,7 +33,8 @@ const jsonContentHeaders = {
  */
 export class API extends ParentAPI {
   /**
-   * Create project
+   * 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
@@ -78,7 +79,10 @@ export class API extends ParentAPI {
     )
 
   /**
-   * 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.
    *
    * @param request - The request {@link ListProjectsRequest}
    * @returns A Promise of ListProjectsResponse
@@ -87,7 +91,9 @@ export class API extends ParentAPI {
     enrichForPagination('projects', this.pageOfListProjects, request)
 
   /**
-   * 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.
    *
    * @param request - The request {@link GetProjectRequest}
    * @returns A Promise of Project
@@ -105,7 +111,10 @@ export class API extends ParentAPI {
     )
 
   /**
-   * 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.
    *
    * @param request - The request {@link DeleteProjectRequest}
    */
@@ -119,7 +128,8 @@ export class API extends ParentAPI {
     })
 
   /**
-   * 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/account/v2/types.gen.ts

@@ -9,67 +9,70 @@ export type ListProjectsRequestOrderBy =
 
 /** List projects response. */
 export interface ListProjectsResponse {
-  /** The total number of projects. */
+  /** Total number of Projects. */
   totalCount: number
-  /** The paginated returned projects. */
+  /** Paginated returned Projects. */
   projects: Project[]
 }
 
 /** Project. */
 export interface Project {
-  /** The ID of the project. */
+  /** ID of the Project. */
   id: string
-  /** The name of the project. */
+  /** Name of the Project. */
   name: string
-  /** The organization ID of the project. */
+  /** Organization ID of the Project. */
   organizationId: string
-  /** The creation date of the project. */
+  /** Creation date of the Project. */
   createdAt?: Date
-  /** The update date of the project. */
+  /** Update date of the Project. */
   updatedAt?: Date
-  /** The description of the project. */
+  /** Description of the Project. */
   description: string
 }
 
 export type CreateProjectRequest = {
-  /** The name of the project. */
+  /** Name of the Project. */
   name: string
-  /** The organization ID of the project. */
+  /** Organization ID of the Project. */
   organizationId?: string
-  /** The description of the project. */
+  /** Description of the Project. */
   description?: string
 }
 
 export type ListProjectsRequest = {
-  /** The organization ID of the project. */
+  /** Organization ID of the Project. */
   organizationId?: string
-  /** The name of the project. */
+  /** Name of the Project. */
   name?: string
-  /** The page number for the returned projects. */
+  /** Page number for the returned Projects. */
   page?: number
-  /** The maximum number of project per page. */
+  /** Maximum number of Project per page. */
   pageSize?: number
-  /** The sort order of the returned projects. */
+  /** Sort order of the returned Projects. */
   orderBy?: ListProjectsRequestOrderBy
-  /** Filter out by a list of project ID. */
+  /**
+   * Project IDs to filter for. The results will be limited to any Projects with
+   * an ID in this array.
+   */
   projectIds?: string[]
 }
 
 export type GetProjectRequest = {
-  /** The project ID of the project. */
+  /** Project ID of the Project. */
   projectId?: string
 }
 
 export type DeleteProjectRequest = {
-  /** The project ID of the project. */
+  /** Project ID of the Project. */
   projectId?: string
 }
 
 export type UpdateProjectRequest = {
-  /** The project ID of the project. */
+  /** Project ID of the Project. */
   projectId?: string
-  /** The name of the project. */
+  /** Name of the Project. */
   name?: string
-  /** The description of the project. */
+  /** Description of the Project. */
   description?: string
 }