Deprecate powerplatform_rest resource (#861)

* Initial plan

* Initial plan for deprecating powerplatform_rest resource

Co-authored-by: mattdot <266258+mattdot@users.noreply.github.com>

* Add deprecation message to powerplatform_rest resource

Co-authored-by: mattdot <266258+mattdot@users.noreply.github.com>

* Update deprecation message to suggest opening GitHub issues

Co-authored-by: mattdot <266258+mattdot@users.noreply.github.com>

* Add changelog entry for powerplatform_rest deprecation

Co-authored-by: mattdot <266258+mattdot@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: mattdot <266258+mattdot@users.noreply.github.com>
Co-authored-by: Matt Dotson <mattdot@users.noreply.github.com>
Co-authored-by: mawasile <50197777+mawasile@users.noreply.github.com>

Author: 3 people

.changes/unreleased/deprecated_powerplatform_rest.yaml

@@ -0,0 +1,4 @@
+kind: deprecated
+body: Mark powerplatform_rest resource as deprecated. Known uses do not align with the intent of the resource. Please consider using specific resources for your use case, or opening a GitHub issue requesting a new resource for your use case.
+custom:
+  Issue: 860

internal/services/rest/resource_rest.go

@@ -76,6 +76,7 @@ func (r *DataverseWebApiResource) Schema(ctx context.Context, req resource.Schem
 	ctx, exitContext := helpers.EnterRequestContext(ctx, r.TypeInfo, req)
 	defer exitContext()
 	resp.Schema = schema.Schema{
+		DeprecationMessage: "This resource is deprecated. Please consider using specific resources for your use case, or opening a GitHub issue requesting a new resource for your use case.",
 		MarkdownDescription: `Resource to execute web api requests. There are four distinct operations, that you can define independently. The HTTP response' body of the operation, that was called as last, will be returned in 'output.body' \n\n:
 		* Create: will be called once during the lifecycle of the resource (first 'terraform apply')
 		* Read: terraform will call this operation every time during 'plan' and 'apply' to get the current state of the resource

internal/services/rest/resource_rest_test.go

@@ -276,3 +276,44 @@ func TestUnitTestRest_Validate_Create(t *testing.T) {
 		},
 	})
 }
+
+func TestUnitTestRest_Deprecation_Still_Works(t *testing.T) {
+	// This test verifies that the deprecated resource still functions correctly
+	// The deprecation warning is handled by the framework and doesn't break functionality
+	httpmock.Activate()
+	defer httpmock.DeactivateAndReset()
+
+	httpmock.RegisterResponder("GET", `https://api.bap.microsoft.com/providers/Microsoft.BusinessAppPlatform/scopes/admin/environments/00000000-0000-0000-0000-000000000001?api-version=2023-06-01`,
+		func(req *http.Request) (*http.Response, error) {
+			return httpmock.NewStringResponse(http.StatusOK, httpmock.File("tests/resource/Web_Api_Validate_Create/get_environment_00000000-0000-0000-0000-000000000001.json").String()), nil
+		})
+
+	httpmock.RegisterResponder("POST", `https://00000000-0000-0000-0000-000000000001.crm4.dynamics.com/api/data/v9.2/accounts?$select=name,accountid`,
+		func(req *http.Request) (*http.Response, error) {
+			return httpmock.NewStringResponse(http.StatusCreated, httpmock.File("tests/resource/Web_Api_Validate_Create/post_account.json").String()), nil
+		})
+
+	resource.Test(t, resource.TestCase{
+		IsUnitTest:               true,
+		ProtoV6ProviderFactories: mocks.TestUnitTestProtoV6ProviderFactories,
+		Steps: []resource.TestStep{
+			{
+				Config: `
+				resource "powerplatform_rest" "deprecated_test" {
+					create = {
+					    scope   = "https://00000000-0000-0000-0000-000000000001.crm4.dynamics.com/.default"
+						url     = "https://00000000-0000-0000-0000-000000000001.crm4.dynamics.com/api/data/v9.2/accounts?$select=name,accountid"
+						method  = "POST"
+						body    = jsonencode({
+							"accountid" : "00000000-0000-0000-0000-000000000001",
+							"name" : "powerplatform_rest"
+						})
+					}
+				}`,
+				Check: resource.ComposeAggregateTestCheckFunc(
+					resource.TestCheckResourceAttr("powerplatform_rest.deprecated_test", "output.body", httpmock.File("tests/resource/Web_Api_Validate_Create/post_account.json").String()),
+				),
+			},
+		},
+	})
+}