v1.0.0

pkg/cloudapi/vins/audits.go

@@ -7,11 +7,14 @@ import (
 	"net/http"
 )
 
+// Request struct for get audits
 type AuditsRequest struct {
+	// ID of the VINS
+	// Required: true
 	VINSID uint64 `url:"vinsId"`
 }
 
-func (vrq AuditsRequest) Validate() error {
+func (vrq AuditsRequest) validate() error {
 	if vrq.VINSID == 0 {
 		return errors.New("validation-error: field VINSID can not be empty or equal to 0")
 	}
@@ -19,25 +22,26 @@ func (vrq AuditsRequest) Validate() error {
 	return nil
 }
 
-func (v VINS) Audits(ctx context.Context, req AuditsRequest) (VINSAuditsList, error) {
-	err := req.Validate()
+// Audits gets audit records for the specified VINS object
+func (v VINS) Audits(ctx context.Context, req AuditsRequest) (ListAudits, error) {
+	err := req.validate()
 	if err != nil {
 		return nil, err
 	}
 
 	url := "/cloudapi/vins/audits"
 
-	auditsRaw, err := v.client.DecortApiCall(ctx, http.MethodPost, url, req)
+	res, err := v.client.DecortApiCall(ctx, http.MethodPost, url, req)
 	if err != nil {
 		return nil, err
 	}
 
-	audits := VINSAuditsList{}
+	list := ListAudits{}
 
-	err = json.Unmarshal(auditsRaw, &audits)
+	err = json.Unmarshal(res, &list)
 	if err != nil {
 		return nil, err
 	}
 
-	return audits, nil
+	return list, nil
 }