feat(ngwaf): add support for signals

Author: anthony-gomez-fastly

CHANGELOG.md

@@ -8,6 +8,7 @@
 
 ### Enhancements:
 - feat(ngwaf): add support for timeseries ([#689](https://github.com/fastly/go-fastly/pull/689))
+- feat(ngwaf): add support for signals ([#692](https://github.com/fastly/go-fastly/pull/692))
 
 ### Bug fixes:
 - fix(logging): Improve documentation of Region and ProcessingRegion fields. ([#690](https://github.com/fastly/go-fastly/pull/690))

fastly/errors.go

@@ -109,6 +109,18 @@ var ErrMissingIsExpired = NewFieldError("IsExpired")
 // requires a "RedactionID" key, but one was not set.
 var ErrMissingRedactionID = NewFieldError("RedactionID")
 
+// ErrMissingSignalID is an error that is returned when an input struct
+// requires a "SignalID" key, but one was not set.
+var ErrMissingSignalID = NewFieldError("SignalID")
+
+// ErrMissingRequestID is an error that is returned when an input struct
+// requires a "RequestID" key, but one was not set.
+var ErrMissingRequestID = NewFieldError("RequestID")
+
+// ErrMissingLimit is an error that is returned when an input struct
+// requires a "Limit" key, but one was not set.
+var ErrMissingLimit = NewFieldError("Limit")
+
 // ErrMissingField is an error that is returned when an input struct
 // requires a "Field" key, but one was not set.
 var ErrMissingField = NewFieldError("Field")

fastly/ngwaf/v1/redactions/api_create.go

@@ -13,11 +13,11 @@ import (
 type CreateInput struct {
 	// Context, if supplied, will be used as the Request's context.
 	Context *context.Context `json:"-"`
-	// Field is the name of the field to redact (required).  Will be converted to lowercase.
+	// Field is the name of the field to redact (required). Will be converted to lowercase.
 	Field *string `json:"field"`
 	// Type is the type of field being redacted. Must be one of `request_parameter`, `request_header`, or `response_header`.
 	Type *string `json:"type"`
-	// WorkspaceID is the ID of the workspace that the redaction is being created in
+	// WorkspaceID is the ID of the workspace that the redaction is being created in.
 	WorkspaceID *string `json:"-"`
 }
 

fastly/ngwaf/v1/redactions/api_response.go

@@ -2,7 +2,7 @@ package redactions
 
 import "time"
 
-// Workspace is the API response structure for the create, update, and get operations.
+// Redaction is the API response structure for the create, update, and get operations.
 type Redaction struct {
 	// CreatedAt is the date and time in ISO 8601 format.
 	CreatedAt time.Time `json:"created_at"`
@@ -14,7 +14,7 @@ type Redaction struct {
 	RedactionID string `json:"id"`
 }
 
-// WorkspRedactionsaces is the API response structure for the list Redactions operation.
+// Redactions is the API response structure for the list Redactions operation.
 type Redactions struct {
 	// Data is the list of returned redactions.
 	Data []Redaction `json:"data"`

fastly/ngwaf/v1/redactions/api_update.go

@@ -13,13 +13,13 @@ import (
 type UpdateInput struct {
 	// Context, if supplied, will be used as the Request's context.
 	Context *context.Context `json:"-"`
-	// Field is the name of the field to redact (required).   Will be converted to lowercase.
+	// Field is the name of the field to redact (required). Will be converted to lowercase.
 	Field *string `json:"field"`
 	// RedactionID is the id of the redaction that's being updated (required).
 	RedactionID *string `json:"-"`
 	// Type is the type of field being redacted. Must be one of `request_parameter`, `request_header`, or `response_header`.
 	Type *string `json:"type"`
-	// WorkspaceID is the ID of the workspace that the redaction is being created in
+	// WorkspaceID is the ID of the workspace that the redaction belongs to.
 	WorkspaceID *string `json:"-"`
 }
 

fastly/ngwaf/v1/signals/api_create.go

@@ -0,0 +1,47 @@
+package signals
+
+import (
+	"context"
+	"encoding/json"
+	"fmt"
+
+	"github.com/fastly/go-fastly/v10/fastly"
+)
+
+// 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:"-"`
+	// Description is a description of the signal (optional).
+	Description *string `json:"description"`
+	// Name is the name of the signal. Must be between 3 and 25 characters. Letters, numbers, hyphens, and spaces are accepted. Special characters and periods are not accepted.
+	Name *string `json:"name"`
+	// WorkspaceID is the ID of the workspace that the signal is being created in.
+	WorkspaceID *string `json:"-"`
+}
+
+// Create creates a new workspace.
+func Create(c *fastly.Client, i *CreateInput) (*Signal, error) {
+	if i.WorkspaceID == nil {
+		return nil, fastly.ErrMissingWorkspaceID
+	}
+	if i.Name == nil {
+		return nil, fastly.ErrMissingName
+	}
+
+	path := fastly.ToSafeURL("ngwaf", "v1", "workspaces", *i.WorkspaceID, "signals")
+
+	resp, err := c.PostJSON(path, i, fastly.CreateRequestOptions(i.Context))
+	if err != nil {
+		return nil, err
+	}
+	defer resp.Body.Close()
+
+	var signal *Signal
+	if err := json.NewDecoder(resp.Body).Decode(&signal); err != nil {
+		return nil, fmt.Errorf("failed to decode json response: %w", err)
+	}
+
+	return signal, nil
+}

fastly/ngwaf/v1/signals/api_delete.go

@@ -0,0 +1,43 @@
+package signals
+
+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
+	// SignalID is the signal identifier (required).
+	SignalID *string
+	// 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
+	}
+	if i.SignalID == nil {
+		return fastly.ErrMissingSignalID
+	}
+
+	path := fastly.ToSafeURL("ngwaf", "v1", "workspaces", *i.WorkspaceID, "signals", *i.SignalID)
+
+	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/signals/api_get.go

@@ -0,0 +1,45 @@
+package signals
+
+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
+	// SignalID is the signal identifier (required).
+	SignalID *string
+	// WorkspaceID is the workspace identifier (required).
+	WorkspaceID *string
+}
+
+// Get retrieves the specified workspace.
+func Get(c *fastly.Client, i *GetInput) (*Signal, error) {
+	if i.WorkspaceID == nil {
+		return nil, fastly.ErrMissingWorkspaceID
+	}
+	if i.SignalID == nil {
+		return nil, fastly.ErrMissingSignalID
+	}
+
+	path := fastly.ToSafeURL("ngwaf", "v1", "workspaces", *i.WorkspaceID, "signals", *i.SignalID)
+
+	resp, err := c.Get(path, fastly.CreateRequestOptions(i.Context))
+	if err != nil {
+		return nil, err
+	}
+	defer resp.Body.Close()
+
+	var signal *Signal
+	if err := json.NewDecoder(resp.Body).Decode(&signal); err != nil {
+		return nil, fmt.Errorf("failed to decode json response: %w", err)
+	}
+
+	return signal, nil
+}

fastly/ngwaf/v1/signals/api_list.go

@@ -0,0 +1,54 @@
+package signals
+
+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
+	// WorkspaceID is the workspace identifier (required).
+	WorkspaceID *string
+}
+
+// List retrieves a list of workspaces, with optional filtering and pagination.
+func List(c *fastly.Client, i *ListInput) (*Signals, 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)
+	}
+
+	path := fastly.ToSafeURL("ngwaf", "v1", "workspaces", *i.WorkspaceID, "signals")
+
+	resp, err := c.Get(path, requestOptions)
+	if err != nil {
+		return nil, err
+	}
+	defer resp.Body.Close()
+
+	var signals *Signals
+	if err := json.NewDecoder(resp.Body).Decode(&signals); err != nil {
+		return nil, fmt.Errorf("failed to decode json response: %w", err)
+	}
+
+	return signals, nil
+}

fastly/ngwaf/v1/signals/api_response.go

@@ -0,0 +1,53 @@
+package signals
+
+import "time"
+
+// Signal is the api response to signals and signals operations.
+type Signal struct {
+	// CreatedAt is the created date and time the event was created in ISO 8601 format.
+	CreatedAt time.Time `json:"created_at"`
+	// Description is the user created description of the signal
+	Description string `json:"description"`
+	// Name is the user created name of the signal.
+	Name string `json:"name"`
+	// ReferenceID is the reference ID of the signal.
+	ReferenceID string `json:"reference_id"`
+	// Scope is the scope that the signal applies to
+	Scope Scope `json:"scope"`
+	// SignalID is the ID of the signal (auto generated).
+	SignalID string `json:"id"`
+	// UpdatedAt is the date and time in ISO 8601 format.
+	UpdatedAt time.Time `json:"updated_at"`
+}
+
+// Signals is the API response structure for the list Signals operation.
+type Signals struct {
+	// Data is the list of returned signals.
+	Data []Signal `json:"data"`
+	// Meta is the information for total signals.
+	Meta MetaSignals `json:"meta"`
+}
+
+// MetaSignals is a subset of the signals response structure.
+type MetaSignals struct {
+	// Limit is the limit of signals.
+	Limit int `json:"limit"`
+	// Total is the sum of signals.
+	Total int `json:"total"`
+}
+
+// Scope is the definition of the scope that a signal applies to.
+type Scope struct {
+	// Type is the type of scope
+	Type string `json:"type"`
+	// AppliesTo defines what scope the signal applies to.
+	AppliesTo []string `json:"applies_to"`
+}
+
+// Reason is the signal that corresponds to the reason an event was triggered.
+type Reason struct {
+	// Signal ID is the ID of the signal that triggered the event
+	SignalID string `json:"signal_id"`
+	// Count is the number of times this signal was detected
+	Count int `json:"count"`
+}