v1.0.0

pkg/cloudapi/compute/delete.go

@@ -7,13 +7,22 @@ import (
 	"strconv"
 )
 
+// Request struct for delete compute
 type DeleteRequest struct {
-	ComputeID   uint64 `url:"computeId"`
-	Permanently bool   `url:"permanently,omitempty"`
-	DetachDisks bool   `url:"detachDisks,omitempty"`
+	// ID of compute instance
+	// Required: true
+	ComputeID uint64 `url:"computeId"`
+
+	// Delete permanently
+	// Required: false
+	Permanently bool `url:"permanently,omitempty"`
+
+	// Set True if you want to detach data disks (if any) from the compute before its deletion
+	// Required: false
+	DetachDisks bool `url:"detachDisks,omitempty"`
 }
 
-func (crq DeleteRequest) Validate() error {
+func (crq DeleteRequest) validate() error {
 	if crq.ComputeID == 0 {
 		return errors.New("validation-error: field ComputeID can not be empty or equal to 0")
 	}
@@ -21,8 +30,9 @@ func (crq DeleteRequest) Validate() error {
 	return nil
 }
 
+// Delete deletes compute
 func (c Compute) Delete(ctx context.Context, req DeleteRequest) (bool, error) {
-	err := req.Validate()
+	err := req.validate()
 	if err != nil {
 		return false, err
 	}
@@ -38,5 +48,6 @@ func (c Compute) Delete(ctx context.Context, req DeleteRequest) (bool, error) {
 	if err != nil {
 		return false, err
 	}
+
 	return result, nil
 }