v1.0.0

pkg/cloudbroker/rg/usage.go

@@ -7,12 +7,18 @@ import (
 	"net/http"
 )
 
+// Request struct for get report of resource usage
 type UsageRequest struct {
-	RGID   uint64 `url:"rgId"`
+	// Resource group ID
+	// Required: true
+	RGID uint64 `url:"rgId"`
+
+	// Reason for action
+	// Required: false
 	Reason string `url:"reason,omitempty"`
 }
 
-func (rgrq UsageRequest) Validate() error {
+func (rgrq UsageRequest) validate() error {
 	if rgrq.RGID == 0 {
 		return errors.New("validation-error: field RGID must be set")
 	}
@@ -20,8 +26,9 @@ func (rgrq UsageRequest) Validate() error {
 	return nil
 }
 
-func (r RG) Usage(ctx context.Context, req UsageRequest) (*Reserved, error) {
-	err := req.Validate()
+// Usage gets report resource usage on the resource group
+func (r RG) Usage(ctx context.Context, req UsageRequest) (*Reservation, error) {
+	err := req.validate()
 	if err != nil {
 		return nil, err
 	}
@@ -33,12 +40,12 @@ func (r RG) Usage(ctx context.Context, req UsageRequest) (*Reserved, error) {
 		return nil, err
 	}
 
-	usage := Reserved{}
+	info := Reservation{}
 
-	err = json.Unmarshal(res, &usage)
+	err = json.Unmarshal(res, &info)
 	if err != nil {
 		return nil, err
 	}
 
-	return &usage, nil
+	return &info, nil
 }