v1.0.0

pkg/cloudapi/rg/access_grant.go

@@ -9,39 +9,61 @@ import (
 	"github.com/rudecs/decort-sdk/internal/validators"
 )
 
+// Request struct for grant access to resource group
 type AccessGrantRequest struct {
-	RGID   uint64 `url:"rgId"`
-	User   string `url:"user"`
-	Right  string `url:"right"`
+	// Resource group ID
+	// Required: true
+	RGID uint64 `url:"rgId"`
+
+	// User or group name to grant access
+	// Required: true
+	User string `url:"user"`
+
+	// Access rights to set, one of:
+	//	- "R"
+	//	-  "RCX"
+	//	- "ARCXDU"
+	// Required: true
+	Right string `url:"right"`
+
+	// Reason for action
+	// Required: false
 	Reason string `url:"reason,omitempty"`
 }
 
-func (rgrq AccessGrantRequest) Validate() error {
+func (rgrq AccessGrantRequest) validate() error {
 	if rgrq.RGID == 0 {
 		return errors.New("field RGID can not be empty or equal to 0")
 	}
-
 	if rgrq.User == "" {
 		return errors.New("field User can not be empty")
 	}
-
-	if !validators.StringInSlice(rgrq.Right, []string{"R", "RCX", "ARCXDU"}) {
+	validate := validators.StringInSlice(rgrq.Right, []string{"R", "RCX", "ARCXDU"})
+	if !validate {
 		return errors.New("field Right can only be one of 'R', 'RCX' or 'ARCXDU'")
 	}
 
 	return nil
 }
 
+// AccessGrant grants user or group access to the resource group as specified
 func (r RG) AccessGrant(ctx context.Context, req AccessGrantRequest) (bool, error) {
-	if err := req.Validate(); err != nil {
+	err := req.validate()
+	if err != nil {
 		return false, err
 	}
 
 	url := "/cloudapi/rg/accessGrant"
+
 	res, err := r.client.DecortApiCall(ctx, http.MethodPost, url, req)
 	if err != nil {
 		return false, err
 	}
 
-	return strconv.ParseBool(string(res))
+	result, err := strconv.ParseBool(string(res))
+	if err != nil {
+		return false, err
+	}
+
+	return result, nil
 }