docs(marketplace): revamp api documentation (#587)

Author: scaleway-bot

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

@@ -59,7 +59,8 @@ export class API extends ParentAPI {
     )
 
   /**
-   * List marketplace images.
+   * List marketplace images. List all available images on the marketplace,
+   * their UUID, CPU architecture and description.
    *
    * @param request - The request {@link ListImagesRequest}
    * @returns A Promise of ListImagesResponse
@@ -68,7 +69,8 @@ export class API extends ParentAPI {
     enrichForPagination('images', this.pageOfListImages, request)
 
   /**
-   * Get a specific marketplace image.
+   * Get a specific marketplace image. Get detailed information about a
+   * marketplace image, specified by its `image_id` (UUID format).
    *
    * @param request - The request {@link GetImageRequest}
    * @returns A Promise of Image
@@ -103,9 +105,24 @@ export class API extends ParentAPI {
       unmarshalListVersionsResponse,
     )
 
+  /**
+   * List versions of an Image. Get a list of all available version of an image,
+   * specified by its `image_id` (UUID format).
+   *
+   * @param request - The request {@link ListVersionsRequest}
+   * @returns A Promise of ListVersionsResponse
+   */
   listVersions = (request: Readonly<ListVersionsRequest>) =>
     enrichForPagination('versions', this.pageOfListVersions, request)
 
+  /**
+   * Get a specific image version. Get information such as the name, creation
+   * date, last update and published date for an image version specified by its
+   * `version_id` (UUID format).
+   *
+   * @param request - The request {@link GetVersionRequest}
+   * @returns A Promise of Version
+   */
   getVersion = (request: Readonly<GetVersionRequest>) =>
     this.client.fetch<Version>(
       {
@@ -155,14 +172,26 @@ export class API extends ParentAPI {
     )
 
   /**
-   * List local images from a specific image or version.
+   * List local images from a specific image or version. List information about
+   * local images in a specific Availability Zone, specified by its `image_id`
+   * (UUID format), `version_id` (UUID format) or `image_label`. Only one of
+   * these three parameters may be set.
    *
    * @param request - The request {@link ListLocalImagesRequest}
    * @returns A Promise of ListLocalImagesResponse
    */
   listLocalImages = (request: Readonly<ListLocalImagesRequest> = {}) =>
     enrichForPagination('localImages', this.pageOfListLocalImages, request)
 
+  /**
+   * Get a specific local image by ID. Get detailed information about a local
+   * image, including compatible commercial types, supported architecture,
+   * labels and the Availability Zone of the image, specified by its
+   * `local_image_id` (UUID format).
+   *
+   * @param request - The request {@link GetLocalImageRequest}
+   * @returns A Promise of LocalImage
+   */
   getLocalImage = (request: Readonly<GetLocalImageRequest>) =>
     this.client.fetch<LocalImage>(
       {
@@ -193,9 +222,23 @@ export class API extends ParentAPI {
       unmarshalListCategoriesResponse,
     )
 
+  /**
+   * List existing image categories. Get a list of all existing categories. The
+   * output can be paginated.
+   *
+   * @param request - The request {@link ListCategoriesRequest}
+   * @returns A Promise of ListCategoriesResponse
+   */
   listCategories = (request: Readonly<ListCategoriesRequest> = {}) =>
     enrichForPagination('categories', this.pageOfListCategories, request)
 
+  /**
+   * Get a specific category. Get information about a specific category of the
+   * marketplace catalog, specified by its `category_id` (UUID format).
+   *
+   * @param request - The request {@link GetCategoryRequest}
+   * @returns A Promise of Category
+   */
   getCategory = (request: Readonly<GetCategoryRequest>) =>
     this.client.fetch<Category>(
       {