v1.0.0

pkg/cloudbroker/disks/list.go

@@ -6,13 +6,26 @@ 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"`
 }
 
+// List gets list the created disks belonging to an account
 func (d Disks) List(ctx context.Context, req ListRequest) (ListDisks, error) {
 	url := "/cloudbroker/disks/list"
 
@@ -21,12 +34,12 @@ func (d Disks) List(ctx context.Context, req ListRequest) (ListDisks, error) {
 		return nil, err
 	}
 
-	listDisks := ListDisks{}
+	list := ListDisks{}
 
-	err = json.Unmarshal(res, &listDisks)
+	err = json.Unmarshal(res, &list)
 	if err != nil {
 		return nil, err
 	}
 
-	return listDisks, nil
+	return list, nil
 }