v1.0.0

pkg/cloudapi/flipgroup/edit.go

@@ -7,26 +7,38 @@ import (
 	"strconv"
 )
 
+// Request struct for edit FLIPGroup
 type EditRequest struct {
-	FlipGroupID uint64 `url:"flipgroupId"`
-	Name        string `url:"name,omitempty"`
+	// FLIPGroup ID
+	// Required: true
+	FLIPGroupID uint64 `url:"flipgroupId"`
+
+	// FLIPGroup name
+	// Required: true
+	Name string `url:"name,omitempty"`
+
+	// FLIPGroup description
+	// Required: true
 	Description string `url:"desc,omitempty"`
 }
 
-func (frq EditRequest) Validate() error {
-	if frq.FlipGroupID == 0 {
-		return errors.New("field FlipGroupID can not be empty or equal to 0")
+func (frq EditRequest) validate() error {
+	if frq.FLIPGroupID == 0 {
+		return errors.New("field FLIPGroupID can not be empty or equal to 0")
 	}
 
 	return nil
 }
 
-func (f FlipGroup) Edit(ctx context.Context, req EditRequest) (bool, error) {
-	if err := req.Validate(); err != nil {
+// Edit edits FLIPGroup fields
+func (f FLIPGroup) Edit(ctx context.Context, req EditRequest) (bool, error) {
+	err := req.validate()
+	if err != nil {
 		return false, err
 	}
 
 	url := "/cloudapi/flipgroup/edit"
+
 	res, err := f.client.DecortApiCall(ctx, http.MethodPost, url, req)
 	if err != nil {
 		return false, err