chore: Addresses "todo" comments from code (#3151)

* resource schema

* test

* include_deleted_with_retained_backups

* adv_config

* use_replication_spec_per_shard

Author: lantoli

internal/service/advancedclustertpf/plural_data_source.go

@@ -66,9 +66,8 @@ func (d *pluralDS) readClusters(ctx context.Context, diags *diag.Diagnostics, pl
 		return nil, diags
 	}
 	outs := &TFModelPluralDS{
-		ProjectID:                         pluralModel.ProjectID,
-		UseReplicationSpecPerShard:        pluralModel.UseReplicationSpecPerShard,
-		IncludeDeletedWithRetainedBackups: pluralModel.IncludeDeletedWithRetainedBackups,
+		ProjectID:                  pluralModel.ProjectID,
+		UseReplicationSpecPerShard: pluralModel.UseReplicationSpecPerShard,
 	}
 	for i := range list {
 		clusterResp := &list[i]

internal/service/advancedclustertpf/schema.go

@@ -208,18 +208,18 @@ func resourceSchema(ctx context.Context) schema.Schema {
 						"container_id": schema.MapAttribute{
 							ElementType:         types.StringType,
 							Computed:            true,
-							MarkdownDescription: "container_id", // TODO: add description
+							MarkdownDescription: "A key-value map of the Network Peering Container ID(s) for the configuration specified in region_configs. The Container ID is the id of the container created when the first cluster in the region (AWS/Azure) or project (GCP) was created.",
 						},
 						"external_id": schema.StringAttribute{
 							Computed:            true,
-							MarkdownDescription: "external_id", // TODO: add description
+							MarkdownDescription: "Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. This value corresponds to Shard ID displayed in the UI.",
 						},
 						"num_shards": schema.Int64Attribute{
 							DeprecationMessage:  deprecationMsgOldSchema("num_shards"),
 							Default:             int64default.StaticInt64(1),
 							Computed:            true,
 							Optional:            true,
-							MarkdownDescription: "num_shards", // TODO: add description
+							MarkdownDescription: "Number of shards up to 50 to deploy for a sharded cluster.",
 						},
 						"region_configs": schema.ListNestedAttribute{
 							Required:            true,
@@ -339,29 +339,26 @@ func pluralDataSourceSchema(ctx context.Context) dsschema.Schema {
 	return conversion.PluralDataSourceSchemaFromResource(resourceSchema(ctx), &conversion.PluralDataSourceSchemaRequest{
 		RequiredFields: []string{"project_id"},
 		OverridenRootFields: map[string]dsschema.Attribute{
-			"use_replication_spec_per_shard": dsschema.BoolAttribute{ // TODO: added as in current resource
-				Optional:            true,
-				MarkdownDescription: "use_replication_spec_per_shard", // TODO: add documentation
-			},
-			"include_deleted_with_retained_backups": dsschema.BoolAttribute{ // TODO: not in current resource, decide if keep
-				Optional:            true,
-				MarkdownDescription: "Flag that indicates whether to return Clusters with retain backups.",
-			},
+			"use_replication_spec_per_shard": useReplicationSpecPerShardSchema(),
 		},
 		OverridenFields: dataSourceOverridenFields(),
 	})
 }
 
 func dataSourceOverridenFields() map[string]dsschema.Attribute {
 	return map[string]dsschema.Attribute{
-		"use_replication_spec_per_shard": dsschema.BoolAttribute{ // TODO: added as in current resource
-			Optional:            true,
-			MarkdownDescription: "use_replication_spec_per_shard", // TODO: add documentation
-		},
+		"use_replication_spec_per_shard":                   useReplicationSpecPerShardSchema(),
 		"accept_data_risks_and_force_replica_set_reconfig": nil,
 	}
 }
 
+func useReplicationSpecPerShardSchema() dsschema.BoolAttribute {
+	return dsschema.BoolAttribute{
+		Optional:            true,
+		MarkdownDescription: "Set this field to true to allow the data source to use the latest schema representing each shard with an individual replication_specs object. This enables representing clusters with independent shard scaling.",
+	}
+}
+
 func AutoScalingSchema() schema.SingleNestedAttribute {
 	return schema.SingleNestedAttribute{
 		Computed:            true,
@@ -439,7 +436,7 @@ func AdvancedConfigurationSchema(ctx context.Context) schema.SingleNestedAttribu
 	return schema.SingleNestedAttribute{
 		Computed:            true,
 		Optional:            true,
-		MarkdownDescription: "advanced_configuration", // TODO: add description
+		MarkdownDescription: "Additional settings for an Atlas cluster.",
 		// Avoid adding optional-only attributes, if the block is removed and attributes are not null in the state we get unintentional plan changes after apply.
 		// Avoid computed-optional with Default, if the block is removed and the attribute Default != state value we get unintentional plan changes after apply.
 		Attributes: map[string]schema.Attribute{
@@ -501,17 +498,16 @@ func AdvancedConfigurationSchema(ctx context.Context) schema.SingleNestedAttribu
 				MarkdownDescription: "Lifetime, in seconds, of multi-document transactions. Atlas considers the transactions that exceed this limit as expired and so aborts them through a periodic cleanup process.",
 			},
 			"default_read_concern": schema.StringAttribute{
-				DeprecationMessage: deprecationMsgOldSchema("default_read_concern"),
-
+				DeprecationMessage:  deprecationMsgOldSchema("default_read_concern"),
 				Computed:            true,
 				Optional:            true,
-				MarkdownDescription: "default_read_concern", // TODO: add description
+				MarkdownDescription: "Default level of acknowledgment requested from MongoDB for read operations set for this cluster.",
 			},
 			"fail_index_key_too_long": schema.BoolAttribute{
 				DeprecationMessage:  deprecationMsgOldSchema("fail_index_key_too_long"),
 				Computed:            true,
 				Optional:            true,
-				MarkdownDescription: "fail_index_key_too_long", // TODO: add description
+				MarkdownDescription: "When true, documents can only be updated or inserted if, for all indexed fields on the target collection, the corresponding index entries do not exceed 1024 bytes. When false, mongod writes documents that exceed the limit but does not index them.",
 			},
 			"default_max_time_ms": schema.Int64Attribute{
 				Computed:            true,
@@ -605,10 +601,9 @@ type TFModelDS struct {
 }
 
 type TFModelPluralDS struct {
-	ProjectID                         types.String `tfsdk:"project_id"`
-	Results                           []*TFModelDS `tfsdk:"results"`
-	UseReplicationSpecPerShard        types.Bool   `tfsdk:"use_replication_spec_per_shard"`        // TODO: added as in current resource
-	IncludeDeletedWithRetainedBackups types.Bool   `tfsdk:"include_deleted_with_retained_backups"` // TODO: not in current resource, decide if keep
+	ProjectID                  types.String `tfsdk:"project_id"`
+	Results                    []*TFModelDS `tfsdk:"results"`
+	UseReplicationSpecPerShard types.Bool   `tfsdk:"use_replication_spec_per_shard"`
 }
 
 type TFBiConnectorModel struct {

internal/testutil/acc/advanced_cluster_preview_provider_v2.go

@@ -137,7 +137,7 @@ func convertAttrs(t *testing.T, name string, writeBody *hclwrite.Body, isList bo
 			break
 		}
 		vals = append(vals, getOneAttr(t, hcl.GetBlockBody(t, match)))
-		writeBody.RemoveBlock(match) // TODO: RemoveBlock doesn't remove newline just after the block so an extra line is added
+		writeBody.RemoveBlock(match) // RemoveBlock doesn't remove newline just after the block so an extra line is added
 	}
 	if len(vals) == 0 {
 		return
@@ -162,7 +162,7 @@ func convertKeyValueAttrs(t *testing.T, name string, writeBody *hclwrite.Body) {
 		key := attrs.GetAttr("key")
 		value := attrs.GetAttr("value")
 		vals[key.AsString()] = value
-		writeBody.RemoveBlock(match) // TODO: RemoveBlock doesn't remove newline just after the block so an extra line is added
+		writeBody.RemoveBlock(match) // RemoveBlock doesn't remove newline just after the block so an extra line is added
 	}
 	if len(vals) > 0 {
 		writeBody.SetAttributeValue(name, cty.ObjectVal(vals))