docs(marketplace): adding marketplace v2 documentation (#1633)

Author: scaleway-bot

api/marketplace/v2/marketplace_sdk.go

@@ -248,6 +248,7 @@ type ListImagesRequest struct {
 }
 
 // ListImages: list marketplace images.
+// List all available images on the marketplace, their UUID, CPU architecture and description.
 func (s *API) ListImages(req *ListImagesRequest, opts ...scw.RequestOption) (*ListImagesResponse, error) {
 	var err error
 
@@ -286,6 +287,7 @@ type GetImageRequest struct {
 }
 
 // GetImage: get a specific marketplace image.
+// Get detailed information about a marketplace image, specified by its `image_id` (UUID format).
 func (s *API) GetImage(req *GetImageRequest, opts ...scw.RequestOption) (*Image, error) {
 	var err error
 
@@ -318,6 +320,8 @@ type ListVersionsRequest struct {
 	OrderBy ListVersionsRequestOrderBy `json:"-"`
 }
 
+// ListVersions: list versions of an Image.
+// Get a list of all available version of an image, specified by its `image_id` (UUID format).
 func (s *API) ListVersions(req *ListVersionsRequest, opts ...scw.RequestOption) (*ListVersionsResponse, error) {
 	var err error
 
@@ -352,6 +356,8 @@ type GetVersionRequest struct {
 	VersionID string `json:"-"`
 }
 
+// GetVersion: 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).
 func (s *API) GetVersion(req *GetVersionRequest, opts ...scw.RequestOption) (*Version, error) {
 	var err error
 
@@ -391,6 +397,7 @@ type ListLocalImagesRequest struct {
 }
 
 // ListLocalImages: 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.
 func (s *API) ListLocalImages(req *ListLocalImagesRequest, opts ...scw.RequestOption) (*ListLocalImagesResponse, error) {
 	var err error
 
@@ -433,6 +440,8 @@ type GetLocalImageRequest struct {
 	LocalImageID string `json:"-"`
 }
 
+// GetLocalImage: 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).
 func (s *API) GetLocalImage(req *GetLocalImageRequest, opts ...scw.RequestOption) (*LocalImage, error) {
 	var err error
 
@@ -461,6 +470,8 @@ type ListCategoriesRequest struct {
 	Page *int32 `json:"-"`
 }
 
+// ListCategories: list existing image categories.
+// Get a list of all existing categories. The output can be paginated.
 func (s *API) ListCategories(req *ListCategoriesRequest, opts ...scw.RequestOption) (*ListCategoriesResponse, error) {
 	var err error
 
@@ -493,6 +504,8 @@ type GetCategoryRequest struct {
 	CategoryID string `json:"-"`
 }
 
+// GetCategory: get a specific category.
+// Get information about a specific category of the marketplace catalog, specified by its `category_id` (UUID format).
 func (s *API) GetCategory(req *GetCategoryRequest, opts ...scw.RequestOption) (*Category, error) {
 	var err error