feat: officially deprecate the metal_device_network_type resource (#773)

equinix · Sep 13, 2024 · f303197 · f303197
1 parent 692594c
commit f303197
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 5 deletions.
diff --git a/docs/resources/metal_device_network_type.md b/docs/resources/metal_device_network_type.md
@@ -2,7 +2,10 @@
 subcategory: "Metal"
 ---
 
-# equinix_metal_device_network_type (Resource)
+# equinix_metal_device_network_type (Resource, Deprecated)
+
+**NOTE:** The metal_device_network_type resource is deprecated and will be removed in v3 of this provider.  Please use metal_port instead.  See the [Metal Device Network Types guide](https://registry.terraform.io/providers/equinix/equinix/latest/docs/guides/network_types) for more info.
+
 
 This resource controls network type of Equinix Metal devices.
 

diff --git a/equinix/resource_metal_device_network_type.go b/equinix/resource_metal_device_network_type.go
@@ -20,9 +20,10 @@ func resourceMetalDeviceNetworkType() *schema.Resource {
 		Delete: resourceMetalDeviceNetworkTypeDelete,
 		Update: resourceMetalDeviceNetworkTypeUpdate,
 		Importer: &schema.ResourceImporter{
+			//nolint
 			State: schema.ImportStatePassthrough,
 		},
-
+		DeprecationMessage: "The metal_device_network_type resource is deprecated and will be removed in v3 of this provider.  Please use metal_port instead.  See the [Metal Device Network Types guide](https://registry.terraform.io/providers/equinix/equinix/latest/docs/guides/network_types) for more info",
 		Schema: map[string]*schema.Schema{
 			"device_id": {
 				Type:        schema.TypeString,
@@ -67,6 +68,7 @@ func getAndPossiblySetNetworkType(d *schema.ResourceData, c *packngo.Client, tar
 	}
 
 	if devType != targetType {
+		//nolint
 		_, err := c.DevicePorts.DeviceToNetworkType(devID, targetType)
 		if err != nil {
 			return err
@@ -112,9 +114,9 @@ func resourceMetalDeviceNetworkTypeRead(d *schema.ResourceData, meta interface{}
 		devNType = "hybrid-bonded"
 	}
 
-	d.Set("type", devNType)
+	err = d.Set("type", devNType)
 
-	return nil
+	return err
 }
 
 func resourceMetalDeviceNetworkTypeUpdate(d *schema.ResourceData, meta interface{}) error {

diff --git a/templates/resources/metal_device_network_type.md.tmpl b/templates/resources/metal_device_network_type.md.tmpl
@@ -6,7 +6,10 @@ subcategory: "Metal"
 
 For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}}
 
-# equinix_metal_device_network_type (Resource)
+# equinix_metal_device_network_type (Resource, Deprecated)
+
+**NOTE:** The metal_device_network_type resource is deprecated and will be removed in v3 of this provider.  Please use metal_port instead.  See the [Metal Device Network Types guide](https://registry.terraform.io/providers/equinix/equinix/latest/docs/guides/network_types) for more info.
+
 
 This resource controls network type of Equinix Metal devices.