[CDTOOL-1055] Add support for ngwaf workspaces

Author: philippschulte

CHANGELOG.md

@@ -7,6 +7,7 @@
 ### Breaking:
 
 ### Enhancements:
+- feat(ngwaf): add support for workspaces ([#679](https://github.com/fastly/go-fastly/pull/679))
 
 ### Bug fixes:
 

fastly/errors.go

@@ -97,6 +97,10 @@ var ErrMissingComputeACLID = NewFieldError("ComputeACLID")
 // requires a "ComputeACLIP" key, but one was not set.
 var ErrMissingComputeACLIP = NewFieldError("ComputeACLIP")
 
+// ErrMissingWorkspaceID is an error that is returned when an input struct
+// requires a "WorkspaceID" key, but one was not set.
+var ErrMissingWorkspaceID = NewFieldError("WorkspaceID")
+
 // ErrMissingContent is an error that is returned when an input struct
 // requires a "Content" key, but one was not set.
 var ErrMissingContent = NewFieldError("Content")

fastly/ngwaf/doc.go

@@ -1,3 +1,3 @@
 // Package ngwaf contains subpackages which offer various operations to
-// configure ngwaf.
+// configure the Fastly Next-Gen WAF.
 package ngwaf

fastly/ngwaf/v1/doc.go

@@ -0,0 +1,4 @@
+// Package v1 contains functionality which allows you to manage
+// Fastly Next-Gen WAF workspaces, requests, events, redactions,
+// tags, and rules using its v1 implementation.
+package v1

fastly/ngwaf/v1/workspaces/api_create.go

@@ -0,0 +1,54 @@
+package workspaces
+
+import (
+	"context"
+	"encoding/json"
+	"fmt"
+
+	"github.com/fastly/go-fastly/v10/fastly"
+)
+
+// AttackSignalThresholdsCreateInput are the parameters for system site alerts.
+type AttackSignalThresholdsCreateInput struct {
+	OneMinute  *int  `json:"one_minute,omitempty"`
+	TenMinutes *int  `json:"ten_minutes,omitempty"`
+	OneHour    *int  `json:"one_hour,omitempty"`
+	Immediate  *bool `json:"immediate,omitempty"`
+}
+
+// CreateInput specifies the information needed for the Create() function to
+// perform the operation.
+type CreateInput struct {
+	// Context, if supplied, will be used as the Request's context.
+	Context *context.Context `json:"-"`
+	// Name is the name of a workspace to create (required).
+	Name *string `json:"name"`
+	// Description is the description of a workspace.
+	Description *string `json:"description"`
+	// Mode is the mode of a workspace.
+	Mode *string `json:"mode"`
+	// AttackSignalThresholds are the parameters for system site alerts.
+	AttackSignalThresholds *AttackSignalThresholdsCreateInput `json:"attack_signal_thresholds,omitempty"`
+	// IPAnonymization is the selected option to anonymize IP addresses.
+	IPAnonymization *string `json:"ip_anonymization"`
+}
+
+// Create creates a new workspace.
+func Create(c *fastly.Client, i *CreateInput) (*Workspace, error) {
+	if i.Name == nil {
+		return nil, fastly.ErrMissingName
+	}
+
+	resp, err := c.PostJSON("/ngwaf/v1/workspaces", i, fastly.CreateRequestOptions(i.Context))
+	if err != nil {
+		return nil, err
+	}
+	defer resp.Body.Close()
+
+	var ws *Workspace
+	if err := json.NewDecoder(resp.Body).Decode(&ws); err != nil {
+		return nil, fmt.Errorf("failed to decode json response: %w", err)
+	}
+
+	return ws, nil
+}

fastly/ngwaf/v1/workspaces/api_delete.go

@@ -0,0 +1,38 @@
+package workspaces
+
+import (
+	"context"
+	"net/http"
+
+	"github.com/fastly/go-fastly/v10/fastly"
+)
+
+// DeleteInput specifies the information needed for the Delete() function to
+// perform the operation.
+type DeleteInput struct {
+	// Context, if supplied, will be used as the Request's context.
+	Context *context.Context
+	// WorkspaceID is the workspace identifier (required).
+	WorkspaceID *string
+}
+
+// Delete deletes the specified workspace.
+func Delete(c *fastly.Client, i *DeleteInput) error {
+	if i.WorkspaceID == nil {
+		return fastly.ErrMissingWorkspaceID
+	}
+
+	path := fastly.ToSafeURL("ngwaf", "v1", "workspaces", *i.WorkspaceID)
+
+	resp, err := c.Delete(path, fastly.CreateRequestOptions(i.Context))
+	if err != nil {
+		return err
+	}
+	defer resp.Body.Close()
+
+	if resp.StatusCode != http.StatusNoContent {
+		return fastly.NewHTTPError(resp)
+	}
+
+	return nil
+}

fastly/ngwaf/v1/workspaces/api_get.go

@@ -0,0 +1,40 @@
+package workspaces
+
+import (
+	"context"
+	"encoding/json"
+	"fmt"
+
+	"github.com/fastly/go-fastly/v10/fastly"
+)
+
+// GetInput specifies the information needed for the Get() function to perform
+// the operation.
+type GetInput struct {
+	// Context, if supplied, will be used as the Request's context.
+	Context *context.Context
+	// WorkspaceID is the workspace identifier (required).
+	WorkspaceID *string
+}
+
+// Get retrieves the specified workspace.
+func Get(c *fastly.Client, i *GetInput) (*Workspace, error) {
+	if i.WorkspaceID == nil {
+		return nil, fastly.ErrMissingWorkspaceID
+	}
+
+	path := fastly.ToSafeURL("ngwaf", "v1", "workspaces", *i.WorkspaceID)
+
+	resp, err := c.Get(path, fastly.CreateRequestOptions(i.Context))
+	if err != nil {
+		return nil, err
+	}
+	defer resp.Body.Close()
+
+	var ws *Workspace
+	if err := json.NewDecoder(resp.Body).Decode(&ws); err != nil {
+		return nil, fmt.Errorf("failed to decode json response: %w", err)
+	}
+
+	return ws, nil
+}

fastly/ngwaf/v1/workspaces/api_list.go

@@ -0,0 +1,50 @@
+package workspaces
+
+import (
+	"context"
+	"encoding/json"
+	"fmt"
+	"strconv"
+
+	"github.com/fastly/go-fastly/v10/fastly"
+)
+
+// ListInput specifies the information needed for the List() function to perform
+// the operation.
+type ListInput struct {
+	// Context, if supplied, will be used as the Request's context.
+	Context *context.Context
+	// Limit how many results are returned.
+	Limit *int
+	// Mode filter results based on mode.
+	Mode *string
+	// Page number of the collection to request.
+	Page *int
+}
+
+// List retrieves a list of workspaces, with optional filtering and pagination.
+func List(c *fastly.Client, i *ListInput) (*Workspaces, error) {
+	requestOptions := fastly.CreateRequestOptions(i.Context)
+	if i.Limit != nil {
+		requestOptions.Params["limit"] = strconv.Itoa(*i.Limit)
+	}
+	if i.Mode != nil {
+		requestOptions.Params["mode"] = *i.Mode
+	}
+	if i.Page != nil {
+		requestOptions.Params["page"] = strconv.Itoa(*i.Page)
+	}
+
+	resp, err := c.Get("/ngwaf/v1/workspaces", requestOptions)
+	if err != nil {
+		return nil, err
+	}
+	defer resp.Body.Close()
+
+	var ws *Workspaces
+	if err := json.NewDecoder(resp.Body).Decode(&ws); err != nil {
+		return nil, fmt.Errorf("failed to decode json response: %w", err)
+	}
+
+	return ws, nil
+}

fastly/ngwaf/v1/workspaces/api_response.go

@@ -0,0 +1,47 @@
+package workspaces
+
+import "time"
+
+// Workspace is the API response structure for the create, update, and get operations.
+type Workspace struct {
+	// WorkspaceID is the workspace identifier (UUID).
+	WorkspaceID string `json:"id"`
+	// Name is the name of the workspace.
+	Name string `json:"name"`
+	// Description is the description of the workspace.
+	Description string `json:"description"`
+	// Mode is the mode of the workspace.
+	Mode string `json:"mode"`
+	// AttackSignalThresholds are the parameters for system site alerts.
+	AttackSignalThresholds AttackSignalThresholds `json:"attack_signal_thresholds"`
+	// IPAnonymization is the selected option to anonymize IP addresses.
+	IPAnonymization string `json:"ip_anonymization"`
+	// CreatedAt is the date and time in ISO 8601 format.
+	CreatedAt time.Time `json:"created_at"`
+	// UpdatedAt is the date and time in ISO 8601 format.
+	UpdatedAt time.Time `json:"updated_at"`
+}
+
+// AttackSignalThresholds are the parameters for system site alerts.
+type AttackSignalThresholds struct {
+	OneMinute  int  `json:"one_minute"`
+	TenMinutes int  `json:"ten_minutes"`
+	OneHour    int  `json:"one_hour"`
+	Immediate  bool `json:"immediate"`
+}
+
+// Workspaces is the API response structure for the list workspaces operation.
+type Workspaces struct {
+	// Data is the list of returned workspaces.
+	Data []Workspace `json:"data"`
+	// Meta is the information for total workspaces.
+	Meta MetaWorkspaces `json:"meta"`
+}
+
+// MetaWorkspaces is a subset of the Workspaces response structure.
+type MetaWorkspaces struct {
+	// Limit is the limit of workspaces.
+	Limit int `json:"limit"`
+	// Total is the sum of workspaces.
+	Total int `json:"total"`
+}