v1.0.0

pkg/cloudapi/k8s/worker_reset.go

@@ -7,21 +7,28 @@ import (
 	"strconv"
 )
 
+// Request struct for hard reset kubernetes cluster
 type WorkerResetRequest struct {
-	K8SID          uint64 `url:"k8sId"`
+	// Kubernetes cluster ID
+	// Required: true
+	K8SID uint64 `url:"k8sId"`
+
+	// ID of the workers compute group
+	// Required: true
 	WorkersGroupID uint64 `url:"workersGroupId"`
-	WorkerID       uint64 `url:"workerId"`
+
+	// Compute ID of worker node to reset
+	// Required: true
+	WorkerID uint64 `url:"workerId"`
 }
 
-func (krq WorkerResetRequest) Validate() error {
+func (krq WorkerResetRequest) validate() error {
 	if krq.K8SID == 0 {
 		return errors.New("validation-error: field K8SID can not be empty or equal to 0")
 	}
-
 	if krq.WorkersGroupID == 0 {
 		return errors.New("validation-error: field WorkersGroupID can not be empty or equal to 0")
 	}
-
 	if krq.WorkerID == 0 {
 		return errors.New("validation-error: field WorkerID can not be empty or equal to 0")
 	}
@@ -29,8 +36,9 @@ func (krq WorkerResetRequest) Validate() error {
 	return nil
 }
 
+// WorkerReset hard reset (compute start + stop) worker node of the Kubernetes cluster
 func (k8s K8S) WorkerReset(ctx context.Context, req WorkerResetRequest) (bool, error) {
-	err := req.Validate()
+	err := req.validate()
 	if err != nil {
 		return false, err
 	}
@@ -46,5 +54,6 @@ func (k8s K8S) WorkerReset(ctx context.Context, req WorkerResetRequest) (bool, e
 	if err != nil {
 		return false, err
 	}
+
 	return result, nil
 }