v1.0.0

pkg/cloudapi/lb/frontend_bind.go

@@ -7,23 +7,39 @@ import (
 	"strings"
 )
 
+// Request struct for frontend bind
 type FrontendBindRequest struct {
-	LBID           uint64 `url:"lbId"`
-	FrontendName   string `url:"frontendName"`
-	BindingName    string `url:"bindingName"`
+	// ID of the load balancer instance to FrontendBind
+	// Required: true
+	LBID uint64 `url:"lbId"`
+
+	// Name of the frontend to update
+	// Required: true
+	FrontendName string `url:"frontendName"`
+
+	// Name of the binding to update
+	// Required: true
+	BindingName string `url:"bindingName"`
+
+	// If specified must be within the IP range of either Ext Net or ViNS,
+	// where this load balancer is connected - new IP address to use for this binding.
+	// If omitted, current IP address is retained
+	// Required: false
 	BindingAddress string `url:"bindingAddress,omitempty"`
-	BindingPort    uint   `url:"bindingPort,omitempty"`
+
+	// New port number to use for this binding.
+	// If omitted, current port number is retained
+	// Required: false
+	BindingPort uint64 `url:"bindingPort,omitempty"`
 }
 
-func (lbrq FrontendBindRequest) Validate() error {
+func (lbrq FrontendBindRequest) validate() error {
 	if lbrq.LBID == 0 {
 		return errors.New("validation-error: field LBID can not be empty or equal to 0")
 	}
-
 	if lbrq.FrontendName == "" {
 		return errors.New("validation-error: field FrontendName can not be empty")
 	}
-
 	if lbrq.BindingName == "" {
 		return errors.New("validation-error: field BindingName can not be empty")
 	}
@@ -31,8 +47,9 @@ func (lbrq FrontendBindRequest) Validate() error {
 	return nil
 }
 
+// FrontendBind bind frontend from specified load balancer instance
 func (l LB) FrontendBind(ctx context.Context, req FrontendBindRequest) (string, error) {
-	err := req.Validate()
+	err := req.validate()
 	if err != nil {
 		return "", err
 	}
@@ -44,5 +61,7 @@ func (l LB) FrontendBind(ctx context.Context, req FrontendBindRequest) (string,
 		return "", err
 	}
 
-	return strings.ReplaceAll(string(res), "\"", ""), nil
+	result := strings.ReplaceAll(string(res), "\"", "")
+
+	return result, nil
 }