v1.0.0

pkg/cloudapi/compute/pfw_del.go

@@ -7,16 +7,35 @@ import (
 	"strconv"
 )
 
+// Request struct for delete port forward rule
 type PFWDelRequest struct {
-	ComputeID       uint64 `url:"computeId"`
-	PFWID           uint64 `url:"ruleId,omitempty"`
+	// ID of compute instance
+	// Required: true
+	ComputeID uint64 `url:"computeId"`
+
+	// ID of the rule to delete. If specified, all other arguments will be ignored
+	// Required: false
+	PFWID uint64 `url:"ruleId,omitempty"`
+
+	// External start port number for the rule
+	// Required: false
 	PublicPortStart uint64 `url:"publicPortStart,omitempty"`
-	PublicPortEnd   uint64 `url:"publicPortEnd,omitempty"`
-	LocalBasePort   uint64 `url:"localBasePort,omitempty"`
-	Proto           string `url:"proto,omitempty"`
+
+	// End port number (inclusive) for the ranged rule
+	// Required: false
+	PublicPortEnd uint64 `url:"publicPortEnd,omitempty"`
+
+	// Internal base port number
+	// Required: false
+	LocalBasePort uint64 `url:"localBasePort,omitempty"`
+
+	// Network protocol
+	// either "tcp" or "udp"
+	// Required: false
+	Proto string `url:"proto,omitempty"`
 }
 
-func (crq PFWDelRequest) Validate() error {
+func (crq PFWDelRequest) validate() error {
 	if crq.ComputeID == 0 {
 		return errors.New("validation-error: field ComputeID can not be empty or equal to 0")
 	}
@@ -24,8 +43,9 @@ func (crq PFWDelRequest) Validate() error {
 	return nil
 }
 
+// PFWDel delete port forward rule
 func (c Compute) PFWDel(ctx context.Context, req PFWDelRequest) (bool, error) {
-	err := req.Validate()
+	err := req.validate()
 	if err != nil {
 		return false, err
 	}