docs: updated scope to use enumeration values in description (#894)

Updated scope to use enumeration values in description along with a note
for REGIONAL extra steps

Author: rfong-eqx

docs/data-sources/fabric_network.md

@@ -57,7 +57,7 @@ output "region" {
 - `notifications` (List of Object) Preferences for notifications on Fabric Network configuration or status changes (see [below for nested schema](#nestedatt--notifications))
 - `operation` (Set of Object) Network operation information that is associated with this Fabric Network (see [below for nested schema](#nestedatt--operation))
 - `project` (Set of Object) Fabric Network project (see [below for nested schema](#nestedatt--project))
-- `scope` (String) Fabric Network scope
+- `scope` (String) Fabric Network scope. Valid values: [REGIONAL GLOBAL LOCAL]. Note: When scope is REGIONAL, the location.region field is required.
 - `state` (String) Fabric Network overall state
 - `type` (String) Supported Network types - EVPLAN, EPLAN, IPWAN, EVPTREE, EPTREE
 

docs/resources/fabric_network.md

@@ -35,7 +35,7 @@ resource "equinix_fabric_network" "new_network" {
 - `name` (String) Fabric Network name. An alpha-numeric 24 characters string which can include only hyphens and underscores
 - `notifications` (Block List, Min: 1) Preferences for notifications on Fabric Network configuration or status changes (see [below for nested schema](#nestedblock--notifications))
 - `project` (Block Set, Min: 1) Fabric Network project (see [below for nested schema](#nestedblock--project))
-- `scope` (String) Fabric Network scope
+- `scope` (String) Fabric Network scope. Valid values: [REGIONAL GLOBAL LOCAL]. Note: When scope is REGIONAL, the location.region field is required.
 - `type` (String) Supported Network types - EVPLAN, EPLAN, IPWAN, EVPTREE, EPTREE
 
 ### Optional

internal/converters/converters.go

@@ -1,3 +1,4 @@
+// Package converters contains functions to convert between different data types and formats.
 package converters
 
 import (
@@ -8,6 +9,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 )
 
+// StringArrToIfArr converts a slice of strings to a slice of any
 func StringArrToIfArr(sli []string) []interface{} {
 	var arr []interface{}
 	for _, v := range sli {
@@ -16,6 +18,7 @@ func StringArrToIfArr(sli []string) []interface{} {
 	return arr
 }
 
+// IfArrToStringArr converts a slice of any to a slice of strings
 func IfArrToStringArr(ifaceArr []interface{}) []string {
 	arr := make([]string, len(ifaceArr))
 	for i, v := range ifaceArr {
@@ -24,6 +27,7 @@ func IfArrToStringArr(ifaceArr []interface{}) []string {
 	return arr
 }
 
+// IfArrToIntStringArr converts a slice of any to a slice of strings, where each element is an int
 func IfArrToIntStringArr(ifaceArr []interface{}) []string {
 	var arr []string
 	for _, v := range ifaceArr {
@@ -35,6 +39,7 @@ func IfArrToIntStringArr(ifaceArr []interface{}) []string {
 	return arr
 }
 
+// IfArrToIntArr converts a slice of any to a slice of ints
 func IfArrToIntArr(ifaceArr []interface{}) []int {
 	var arr []int
 	for _, v := range ifaceArr {
@@ -46,10 +51,12 @@ func IfArrToIntArr(ifaceArr []interface{}) []int {
 	return arr
 }
 
+// ToLowerIf converts an any to a string and converts it to lowercase
 func ToLowerIf(v interface{}) string {
 	return strings.ToLower(v.(string))
 }
 
+// Difference returns the difference between two slices of strings.
 // from https://stackoverflow.com/a/45428032
 func Difference(a, b []string) []string {
 	mb := make(map[string]struct{}, len(b))
@@ -65,6 +72,7 @@ func Difference(a, b []string) []string {
 	return diff
 }
 
+// ListToInt32List converts a slice of any to a slice of int32
 func ListToInt32List(list []interface{}) []int32 {
 	result := make([]int32, len(list))
 	for i, v := range list {
@@ -73,15 +81,26 @@ func ListToInt32List(list []interface{}) []int32 {
 	return result
 }
 
+// SetToStringList converts a schema.Set to a slice of strings
 func SetToStringList(set *schema.Set) []string {
 	list := set.List()
 	return IfArrToStringArr(list)
 }
 
+// InterfaceMapToStringMap converts a string map of any values to a string map of strings
 func InterfaceMapToStringMap(mapIn map[string]interface{}) map[string]string {
 	mapOut := make(map[string]string)
 	for k, v := range mapIn {
 		mapOut[k] = fmt.Sprintf("%v", v)
 	}
 	return mapOut
 }
+
+// EnumArrayToStringArray converts a slice of string-like enums to a slice of strings
+func EnumArrayToStringArray[T ~string, S []T](list S) []string {
+	arr := make([]string, len(list))
+	for i, v := range list {
+		arr[i] = string(v)
+	}
+	return arr
+}

internal/resources/fabric/network/resource_schema.go

@@ -1,6 +1,10 @@
 package network
 
 import (
+	"fmt"
+
+	"github.com/equinix/equinix-sdk-go/services/fabricv4"
+	"github.com/equinix/terraform-provider-equinix/internal/converters"
 	equinix_fabric_schema "github.com/equinix/terraform-provider-equinix/internal/fabric/schema"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
@@ -68,9 +72,15 @@ func fabricNetworkResourceSchema() map[string]*schema.Schema {
 			Description: "Fabric Network overall state",
 		},
 		"scope": {
-			Type:        schema.TypeString,
-			Required:    true,
-			Description: "Fabric Network scope",
+			Type:     schema.TypeString,
+			Required: true,
+			ValidateFunc: validation.StringInSlice(
+				converters.EnumArrayToStringArray(fabricv4.AllowedNetworkScopeEnumValues),
+				true,
+			),
+			Description: fmt.Sprintf("Fabric Network scope. Valid values: %v. Note: When scope is REGIONAL, the location.region field is required.",
+				fabricv4.AllowedNetworkScopeEnumValues,
+			),
 		},
 		"type": {
 			Type:         schema.TypeString,