v1.0.0

pkg/cloudapi/rg/list.go

@@ -6,23 +6,36 @@ import (
 	"net/http"
 )
 
+// Request struct for get list of resource groups
 type ListRequest struct {
-	IncludeDeleted bool   `url:"includedeleted,omitempty"`
-	Page           uint64 `url:"page,omitempty"`
-	Size           uint64 `url:"size,omitempty"`
+	// Included deleted resource groups
+	// Required: false
+	IncludeDeleted bool `url:"includedeleted,omitempty"`
+
+	// Page number
+	// Required: false
+	Page uint64 `url:"page,omitempty"`
+
+	// Page size
+	// Required: false
+	Size uint64 `url:"size,omitempty"`
 }
 
-func (r RG) List(ctx context.Context, req ListRequest) (ResourceGroupList, error) {
+// List gets list of all resource groups the user has access to
+func (r RG) List(ctx context.Context, req ListRequest) (ListResourceGroups, error) {
 	url := "/cloudapi/rg/list"
-	rgListRaw, err := r.client.DecortApiCall(ctx, http.MethodPost, url, req)
+
+	res, err := r.client.DecortApiCall(ctx, http.MethodPost, url, req)
 	if err != nil {
 		return nil, err
 	}
 
-	rgList := ResourceGroupList{}
-	if err := json.Unmarshal(rgListRaw, &rgList); err != nil {
+	list := ListResourceGroups{}
+
+	err = json.Unmarshal(res, &list)
+	if err != nil {
 		return nil, err
 	}
 
-	return rgList, nil
+	return list, nil
 }