prepare 2.17.0 release

docs/data-sources/environment.md

@@ -56,5 +56,5 @@ Read-Only:
 - `min_num_approvals` (Number)
 - `required` (Boolean)
 - `required_approval_tags` (List of String)
+- `service_config` (Map of String)
 - `service_kind` (String)
-- `service_config` (Block List)

docs/resources/environment.md

@@ -82,19 +82,11 @@ Optional:
 - `min_num_approvals` (Number) The number of approvals required before an approval request can be applied. This number must be between 1 and 5. Defaults to 1.
 - `required` (Boolean) Set to `true` for changes to flags in this environment to require approval. You may only set `required` to true if `required_approval_tags` is not set and vice versa. Defaults to `false`.
 - `required_approval_tags` (List of String) An array of tags used to specify which flags with those tags require approval. You may only set `required_approval_tags` if `required` is not set to `true` and vice versa.
-- `service_kind` (String) The kind of service to use when requesting an approval. Use this to switch which system approval requests go to. Valid values are `launchdarkly` and `servicenow`. The default is `launchdarkly`.
-- `service_config` (Block List) The config for the approval service. This will differ for different kinds of services. (See [below for nested schema](#nestedblock--approval_settings_service_config))
+- `service_config` (Map of String) The configuration for the service associated with this approval. This is specific to each approval service. For a `service_kind` of `servicenow`, the following fields apply:
 
-<a id="nestedblock--approval_settings_service_config"></a>
-### Nested Schema for `service_config`
-The structure of the `service_config` object will be different for each different service kind.
-
-For a `service_kind` of `servicenow`:
-
-- `detail_column` (String) The name of the column to place the details in when creating the change request in ServiceNow.
-- `template` (String) The sys_id of the Standard Change Request Template in ServiceNow to use when creating the change request.
-
-For a `service_kind` of `launchdarkly`: No properties are required.
+	 - `template` (String) The sys_id of the Standard Change Request Template in ServiceNow that LaunchDarkly will use when creating the change request.
+	 - `detail_column` (String) The name of the ServiceNow Change Request column LaunchDarkly uses to populate detailed approval request information.
+- `service_kind` (String) The kind of service associated with this approval. This determines which platform is used for requesting approval. Valid values are `servicenow`, `launchdarkly`.
 
 ## Import
 

docs/resources/project.md

@@ -98,21 +98,12 @@ Nested environments `approval_settings` blocks have the following structure:
 
 - `required_approval_tags` - An array of tags used to specify which flags with those tags require approval. You may only set `required_approval_tags` if `required` is not set to `true` and vice versa.
 
-- `service_kind` (String) The kind of service to use when requesting an approval. Use this to switch which system approval requests go to. Valid values are `launchdarkly` and `servicenow`. The default is `launchdarkly`.
--
-- `service_config` (Block List) The config for the approval service. This will differ for different kinds of services. (See [below for nested schema](#nestedblock--approval_settings_service_config))
+- `service_config` (Map of String) The configuration for the service associated with this approval. This is specific to each approval service. For a `service_kind` of `servicenow`, the following fields apply:
 
-<a id="nestedblock--approval_settings_service_config"></a>
-### Nested Schema for `service_config`
+  - `template` (String) The sys_id of the Standard Change Request Template in ServiceNow that LaunchDarkly will use when creating the change request.
+  - `detail_column` (String) The name of the ServiceNow Change Request column LaunchDarkly uses to populate detailed approval request information.
 
-The structure of the `service_config` object will be different for each different service kind.
-
-For a `service_kind` of `servicenow`:
-
-- `detail_column` (String) The name of the column to place the details in when creating the change request in ServiceNow.
-- `template` (String) The sys_id of the Standard Change Request Template in ServiceNow to use when creating the change request.
-
-For a `service_kind` of `launchdarkly`: No properties are required.
+- `service_kind` (String) The kind of service associated with this approval. This determines which platform is used for requesting approval. Valid values are `servicenow`, `launchdarkly`.
 
 ### Nested Client side Availability Block
 

go.mod

@@ -83,7 +83,7 @@ require (
 	golang.org/x/tools v0.6.0 // indirect
 	google.golang.org/appengine v1.6.7 // indirect
 	google.golang.org/genproto v0.0.0-20230410155749-daa745c078e1 // indirect
-	google.golang.org/grpc v1.56.1 // indirect
+	google.golang.org/grpc v1.56.3 // indirect
 	google.golang.org/protobuf v1.31.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

go.sum

@@ -1359,8 +1359,8 @@ google.golang.org/grpc v1.40.0/go.mod h1:ogyxbiOoUXAkP+4+xa6PZSE9DZgIHtSpzjDTB9K
 google.golang.org/grpc v1.40.1/go.mod h1:ogyxbiOoUXAkP+4+xa6PZSE9DZgIHtSpzjDTB9KAK34=
 google.golang.org/grpc v1.42.0/go.mod h1:k+4IHHFw41K8+bbowsex27ge2rCb65oeWqe4jJ590SU=
 google.golang.org/grpc v1.43.0/go.mod h1:k+4IHHFw41K8+bbowsex27ge2rCb65oeWqe4jJ590SU=
-google.golang.org/grpc v1.56.1 h1:z0dNfjIl0VpaZ9iSVjA6daGatAYwPGstTjt5vkRMFkQ=
-google.golang.org/grpc v1.56.1/go.mod h1:I9bI3vqKfayGqPUAwGdOSu7kt6oIJLixfffKrpXqQ9s=
+google.golang.org/grpc v1.56.3 h1:8I4C0Yq1EjstUzUJzpcRVbuYA2mODtEmpWiQoN/b2nc=
+google.golang.org/grpc v1.56.3/go.mod h1:I9bI3vqKfayGqPUAwGdOSu7kt6oIJLixfffKrpXqQ9s=
 google.golang.org/grpc/cmd/protoc-gen-go-grpc v1.1.0/go.mod h1:6Kw0yEErY5E/yWrBtf03jp27GLLJujG4z/JK95pnjjw=
 google.golang.org/protobuf v0.0.0-20200109180630-ec00e32a8dfd/go.mod h1:DFci5gLYBciE7Vtevhsrf46CRTquxDuWsQurQQe4oz8=
 google.golang.org/protobuf v0.0.0-20200221191635-4d8936d0db64/go.mod h1:kwYJMbMJ01Woi6D6+Kah6886xMZcty6N08ah7+eCXa0=

launchdarkly/approvals_helper.go

@@ -56,17 +56,18 @@ func approvalSchema(options approvalSchemaOptions) *schema.Schema {
 			},
 		},
 		SERVICE_KIND: {
-			Type: schema.TypeString,
-			Optional: !options.isDataSource,
-			Computed: options.isDataSource,
-			Description: "The kind of service that is associated with this approval. This is used to determine which platform is used for requesting approval. Valid values are `servicenow`, `launchdarkly`.",
-			Default: "launchdarkly",
+			Type:             schema.TypeString,
+			Optional:         !options.isDataSource,
+			Computed:         options.isDataSource,
+			Description:      "The kind of service associated with this approval. This determines which platform is used for requesting approval. Valid values are `servicenow`, `launchdarkly`.",
+			Default:          "launchdarkly",
+			ValidateDiagFunc: validation.ToDiagFunc(validation.StringInSlice([]string{"servicenow", "launchdarkly"}, false)),
 		},
 		SERVICE_CONFIG: {
-			Type: schema.TypeMap,
-			Optional: !options.isDataSource,
-			Computed: options.isDataSource,
-			Description: "The configuration for the service that is associated with this approval. This will be specific to each approval service.",
+			Type:        schema.TypeMap,
+			Optional:    !options.isDataSource,
+			Computed:    options.isDataSource,
+			Description: "The configuration for the service associated with this approval. This is specific to each approval service. For a `service_kind` of `servicenow`, the following fields apply:\n\n\t - `template` (String) The sys_id of the Standard Change Request Template in ServiceNow that LaunchDarkly will use when creating the change request.\n\t - `detail_column` (String) The name of the ServiceNow Change Request column LaunchDarkly uses to populate detailed approval request information. ",
 		},
 	}
 
@@ -94,8 +95,8 @@ func approvalSettingsFromResourceData(val interface{}) (ldapi.ApprovalSettings,
 		CanReviewOwnRequest:     approvalSettingsMap[CAN_REVIEW_OWN_REQUEST].(bool),
 		MinNumApprovals:         int32(approvalSettingsMap[MIN_NUM_APPROVALS].(int)),
 		CanApplyDeclinedChanges: approvalSettingsMap[CAN_APPLY_DECLINED_CHANGES].(bool),
-		ServiceKind: approvalSettingsMap[SERVICE_KIND].(string),
-		ServiceConfig: approvalSettingsMap[SERVICE_CONFIG].(map[string]interface{}),
+		ServiceKind:             approvalSettingsMap[SERVICE_KIND].(string),
+		ServiceConfig:           approvalSettingsMap[SERVICE_CONFIG].(map[string]interface{}),
 	}
 	// Required and RequiredApprovalTags should never be defined simultaneously
 	// unfortunately since they default to their null values and are nested we cannot tell if the

launchdarkly/environments_helper_test.go

@@ -79,8 +79,8 @@ func TestEnvironmentToResourceData(t *testing.T) {
 					CanApplyDeclinedChanges: true,
 					RequiredApprovalTags:    []string{"approval"},
 					CanReviewOwnRequest:     true,
-					ServiceKind: "launchdarkly",
-					ServiceConfig: map[string]interface{}(nil),
+					ServiceKind:             "launchdarkly",
+					ServiceConfig:           map[string]interface{}(nil),
 				},
 			},
 			expected: envResourceData{
@@ -103,8 +103,8 @@ func TestEnvironmentToResourceData(t *testing.T) {
 						CAN_APPLY_DECLINED_CHANGES: true,
 						REQUIRED_APPROVAL_TAGS:     []string{"approval"},
 						REQUIRED:                   true,
-						SERVICE_KIND: "launchdarkly",
-						SERVICE_CONFIG: map[string]interface{}(nil),
+						SERVICE_KIND:               "launchdarkly",
+						SERVICE_CONFIG:             map[string]interface{}(nil),
 					},
 				},
 			},

launchdarkly/resource_launchdarkly_project.go

@@ -253,7 +253,7 @@ func resourceProjectUpdate(ctx context.Context, d *schema.ResourceData, metaRaw
 		}
 		_, _, err = client.ld.EnvironmentsApi.PatchEnvironment(client.ctx, projectKey, envKey).PatchOperation(patch).Execute()
 		if err != nil {
-			return diag.Errorf("failed to update environment with key %q for project: %q: %+v", envKey, projectKey, err)
+			return diag.Errorf("failed to update environment with key %q for project: %q: %+v", envKey, projectKey, handleLdapiErr(err))
 		}
 	}
 	// we also want to delete environments that were previously tracked in state and have been removed from the config

templates/resources/project.md

@@ -98,6 +98,13 @@ Nested environments `approval_settings` blocks have the following structure:
 
 - `required_approval_tags` - An array of tags used to specify which flags with those tags require approval. You may only set `required_approval_tags` if `required` is not set to `true` and vice versa.
 
+- `service_config` (Map of String) The configuration for the service associated with this approval. This is specific to each approval service. For a `service_kind` of `servicenow`, the following fields apply:
+
+  - `template` (String) The sys_id of the Standard Change Request Template in ServiceNow that LaunchDarkly will use when creating the change request.
+  - `detail_column` (String) The name of the ServiceNow Change Request column LaunchDarkly uses to populate detailed approval request information.
+
+- `service_kind` (String) The kind of service associated with this approval. This determines which platform is used for requesting approval. Valid values are `servicenow`, `launchdarkly`.
+
 ### Nested Client side Availability Block
 
 The nested `default_client_side_availability` block describes which client-side SDKs can use new flags by default. To learn more about this setting, read [Making flags available to client-side and mobile SDKs](https://docs.launchdarkly.com/home/getting-started/feature-flags#making-flags-available-to-client-side-and-mobile-sdks). This block has the following structure: