v1.0.0

pkg/cloudapi/compute/affinity_rule_add.go

@@ -9,50 +9,68 @@ import (
 	"github.com/rudecs/decort-sdk/internal/validators"
 )
 
+// Request struct for add affinity rule
 type AffinityRuleAddRequest struct {
+	// ID of the compute instance
+	// Required: true
 	ComputeID uint64 `url:"computeId"`
-	Topology  string `url:"topology"`
-	Policy    string `url:"policy"`
-	Mode      string `url:"mode"`
-	Key       string `url:"key"`
-	Value     string `url:"value"`
+
+	// Compute or node, for whom rule applies
+	// Required: true
+	Topology string `url:"topology"`
+
+	// The degree of 'strictness' of this rule
+	// Should be one of:
+	//	- RECOMMENDED
+	//	- REQUIRED
+	// Required: true
+	Policy string `url:"policy"`
+
+	// The comparison mode is 'value', recorded by the specified 'key'
+	// Should be one of:
+	//	- EQ
+	//	- EN
+	//	- ANY
+	// Required: true
+	Mode string `url:"mode"`
+
+	// Key that are taken into account when analyzing this rule will be identified
+	// Required: true
+	Key string `url:"key"`
+
+	// Value that must match the key to be taken into account when analyzing this rule
+	// Required: true
+	Value string `url:"value"`
 }
 
-func (crq AffinityRuleAddRequest) Validate() error {
+func (crq AffinityRuleAddRequest) validate() error {
 	if crq.ComputeID == 0 {
 		return errors.New("validation-error: field ComputeID can not be empty or equal to 0")
 	}
 	if crq.Topology == "" {
 		return errors.New("validation-error: field Topology can not be empty")
 	}
-
 	validator := validators.StringInSlice(crq.Topology, []string{"compute", "node"})
 	if !validator {
 		return errors.New("validation-error: field Topology can be only compute or node")
 	}
-
 	if crq.Policy == "" {
 		return errors.New("validation-error: field Policy can not be empty")
 	}
-
 	validator = validators.StringInSlice(crq.Policy, []string{"RECOMMENDED", "REQUIRED"})
 	if !validator {
 		return errors.New("validation-error: field Policy can be only RECOMMENDED or REQUIRED")
 	}
-
 	if crq.Mode == "" {
 		return errors.New("validation-error: field Mode can not be empty")
 	}
-
 	validator = validators.StringInSlice(crq.Mode, []string{"EQ", "NE", "ANY"})
 	if !validator {
 		return errors.New("validation-error: field Mode can be only EQ, NE or ANY")
 	}
-
 	if crq.Key == "" {
 		return errors.New("validation-error: field Key can not be empty")
 	}
-
 	if crq.Value == "" {
 		return errors.New("validation-error: field Value can not be empty")
 	}
@@ -60,8 +78,9 @@ func (crq AffinityRuleAddRequest) Validate() error {
 	return nil
 }
 
+// AffinityRuleAdd add affinity rule
 func (c Compute) AffinityRuleAdd(ctx context.Context, req AffinityRuleAddRequest) (bool, error) {
-	err := req.Validate()
+	err := req.validate()
 	if err != nil {
 		return false, err
 	}