v1.0.0

pkg/cloudapi/disks/list.go

@@ -6,14 +6,27 @@ import (
 	"net/http"
 )
 
+// Request struct for get list/list_deleted of disks
 type ListRequest struct {
+	// ID of the account the disks belong to
+	// Required: false
 	AccountID uint64 `url:"accountId,omitempty"`
-	Type      string `url:"type,omitempty"`
-	Page      uint64 `url:"page,omitempty"`
-	Size      uint64 `url:"size,omitempty"`
+
+	// Type of the disks
+	// Required: false
+	Type string `url:"type,omitempty"`
+
+	// Page number
+	// Required: false
+	Page uint64 `url:"page,omitempty"`
+
+	// Page size
+	// Required: false
+	Size uint64 `url:"size,omitempty"`
 }
 
-func (d Disks) List(ctx context.Context, req ListRequest) (DiskList, error) {
+// List gets list the created disks belonging to an account
+func (d Disks) List(ctx context.Context, req ListRequest) (ListDisks, error) {
 	url := "/cloudapi/disks/list"
 
 	res, err := d.client.DecortApiCall(ctx, http.MethodPost, url, req)
@@ -21,34 +34,31 @@ func (d Disks) List(ctx context.Context, req ListRequest) (DiskList, error) {
 		return nil, err
 	}
 
-	diskList := DiskList{}
+	list := ListDisks{}
 
-	err = json.Unmarshal(res, &diskList)
+	err = json.Unmarshal(res, &list)
 	if err != nil {
 		return nil, err
 	}
 
-	return diskList, nil
-
+	return list, nil
 }
 
-func (d Disks) ListDeleted(ctx context.Context, req ListRequest) (DiskList, error) {
-	url := "/disks/listDeleted"
-	prefix := "/cloudapi"
+// ListDeleted gets list the deleted disks belonging to an account
+func (d Disks) ListDeleted(ctx context.Context, req ListRequest) (ListDisks, error) {
+	url := "/cloudapi/disks/listDeleted"
 
-	url = prefix + url
 	res, err := d.client.DecortApiCall(ctx, http.MethodPost, url, req)
 	if err != nil {
 		return nil, err
 	}
 
-	diskList := DiskList{}
+	list := ListDisks{}
 
-	err = json.Unmarshal(res, &diskList)
+	err = json.Unmarshal(res, &list)
 	if err != nil {
 		return nil, err
 	}
 
-	return diskList, nil
-
+	return list, nil
 }