v1.0.0

pkg/cloudapi/compute/disk_add.go

@@ -7,26 +7,53 @@ import (
 	"strconv"
 )
 
+// Request struct for create and attach disk to compute
 type DiskAddRequest struct {
-	ComputeID   uint64 `url:"computeId"`
-	DiskName    string `url:"diskName"`
-	Size        uint64 `url:"size"`
-	DiskType    string `url:"diskType,omitempty"`
-	SepID       uint64 `url:"sepId,omitempty"`
-	Pool        string `url:"pool,omitempty"`
+	// ID of compute instance
+	// Required: true
+	ComputeID uint64 `url:"computeId"`
+
+	// Name for disk
+	// Required: true
+	DiskName string `url:"diskName"`
+
+	// Disk size in GB
+	// Required: true
+	Size uint64 `url:"size"`
+
+	// Type of the disk
+	// Should be one of:
+	//	- D
+	//	- B
+	// Required: false
+	DiskType string `url:"diskType,omitempty"`
+
+	// Storage endpoint provider ID
+	// By default the same with boot disk
+	// Required: false
+	SepID uint64 `url:"sepId,omitempty"`
+
+	// Pool name
+	// By default will be chosen automatically
+	// Required: false
+	Pool string `url:"pool,omitempty"`
+
+	// Optional description
+	// Required: false
 	Description string `url:"desc,omitempty"`
-	ImageID     uint64 `url:"imageId,omitempty"`
+
+	// Specify image id for create disk from template
+	// Required: false
+	ImageID uint64 `url:"imageId,omitempty"`
 }
 
-func (crq DiskAddRequest) Validate() error {
+func (crq DiskAddRequest) validate() error {
 	if crq.ComputeID == 0 {
 		return errors.New("validation-error: field ComputeID can not be empty or equal to 0")
 	}
-
 	if crq.Size == 0 {
 		return errors.New("validation-error: field Size can not be empty or equal to 0")
 	}
-
 	if crq.DiskName == "" {
 		return errors.New("validation-error: field DiskName can not be empty or equal to 0")
 	}
@@ -34,8 +61,9 @@ func (crq DiskAddRequest) Validate() error {
 	return nil
 }
 
+// DiskAdd creates new disk and attach to compute
 func (c Compute) DiskAdd(ctx context.Context, req DiskAddRequest) (uint64, error) {
-	err := req.Validate()
+	err := req.validate()
 	if err != nil {
 		return 0, err
 	}