github.com/akamai/AkamaiOPEN-edgegrid-golang/v8@v8.1.0/pkg/botman/bot_endpoint_coverage_report.go (about)

     1  package botman
     2  
     3  import (
     4  	"context"
     5  	"fmt"
     6  	"net/http"
     7  
     8  	validation "github.com/go-ozzo/ozzo-validation/v4"
     9  )
    10  
    11  type (
    12  	// The BotEndpointCoverageReport interface supports retrieving bot endpoint coverage report for an account or a specific configuration
    13  	BotEndpointCoverageReport interface {
    14  		// GetBotEndpointCoverageReport https://techdocs.akamai.com/bot-manager/reference/get-bot-endpoint-coverage-report
    15  		GetBotEndpointCoverageReport(ctx context.Context, params GetBotEndpointCoverageReportRequest) (*GetBotEndpointCoverageReportResponse, error)
    16  	}
    17  
    18  	// GetBotEndpointCoverageReportRequest is used to retrieve the akamai bot category actions for a policy.
    19  	GetBotEndpointCoverageReportRequest struct {
    20  		ConfigID    int64
    21  		Version     int64
    22  		OperationID string
    23  	}
    24  
    25  	// GetBotEndpointCoverageReportResponse is returned from a call to GetBotEndpointCoverageReport.
    26  	GetBotEndpointCoverageReportResponse struct {
    27  		Operations []map[string]interface{} `json:"operations"`
    28  	}
    29  )
    30  
    31  // Validate validates GetBotEndpointCoverageReportRequest
    32  func (v GetBotEndpointCoverageReportRequest) Validate() error {
    33  	return validation.Errors{
    34  		"ConfigID": validation.Validate(v.ConfigID, validation.When(v.Version != 0, validation.Required)),
    35  		"Version":  validation.Validate(v.Version, validation.When(v.ConfigID != 0, validation.Required)),
    36  	}.Filter()
    37  }
    38  
    39  func (b *botman) GetBotEndpointCoverageReport(ctx context.Context, params GetBotEndpointCoverageReportRequest) (*GetBotEndpointCoverageReportResponse, error) {
    40  	logger := b.Log(ctx)
    41  	logger.Debug("GetBotEndpointCoverageReport")
    42  
    43  	if err := params.Validate(); err != nil {
    44  		return nil, fmt.Errorf("%w: %s", ErrStructValidation, err.Error())
    45  	}
    46  
    47  	var uri string
    48  	if params.ConfigID != 0 && params.Version != 0 {
    49  		uri = fmt.Sprintf("/appsec/v1/configs/%d/versions/%d/bot-endpoint-coverage-report", params.ConfigID, params.Version)
    50  	} else {
    51  		uri = "/appsec/v1/bot-endpoint-coverage-report"
    52  	}
    53  
    54  	req, err := http.NewRequestWithContext(ctx, http.MethodGet, uri, nil)
    55  	if err != nil {
    56  		return nil, fmt.Errorf("failed to create GetBotEndpointCoverageReport request: %w", err)
    57  	}
    58  
    59  	var result GetBotEndpointCoverageReportResponse
    60  	resp, err := b.Exec(req, &result)
    61  	if err != nil {
    62  		return nil, fmt.Errorf("GetBotEndpointCoverageReport request failed: %w", err)
    63  	}
    64  
    65  	if resp.StatusCode != http.StatusOK {
    66  		return nil, b.Error(resp)
    67  	}
    68  
    69  	var filteredResult GetBotEndpointCoverageReportResponse
    70  	if params.OperationID != "" {
    71  		for _, val := range result.Operations {
    72  			if val["operationId"].(string) == params.OperationID {
    73  				filteredResult.Operations = append(filteredResult.Operations, val)
    74  			}
    75  		}
    76  	} else {
    77  		filteredResult = result
    78  	}
    79  	return &filteredResult, nil
    80  }