add comment and rename helper function

Author: vandyliu

internal/provider/datasources/data_source_deployments.go

@@ -83,9 +83,9 @@ func (d *deploymentsDataSource) Read(
 	params := &platform.ListDeploymentsParams{
 		Limit: lo.ToPtr(1000),
 	}
-	params.DeploymentIds = utils.TypesListToStringSlice(data.DeploymentIds)
-	params.WorkspaceIds = utils.TypesListToStringSlice(data.WorkspaceIds)
-	params.Names = utils.TypesListToStringSlice(data.Names)
+	params.DeploymentIds = utils.TypesListToStringSlicePtr(data.DeploymentIds)
+	params.WorkspaceIds = utils.TypesListToStringSlicePtr(data.WorkspaceIds)
+	params.Names = utils.TypesListToStringSlicePtr(data.Names)
 
 	if resp.Diagnostics.HasError() {
 		return

internal/provider/datasources/data_source_workspaces.go

@@ -83,8 +83,8 @@ func (d *workspacesDataSource) Read(
 	params := &platform.ListWorkspacesParams{
 		Limit: lo.ToPtr(1000),
 	}
-	params.WorkspaceIds = utils.TypesListToStringSlice(data.WorkspaceIds)
-	params.Names = utils.TypesListToStringSlice(data.Names)
+	params.WorkspaceIds = utils.TypesListToStringSlicePtr(data.WorkspaceIds)
+	params.Names = utils.TypesListToStringSlicePtr(data.Names)
 
 	if resp.Diagnostics.HasError() {
 		return

internal/utils/list.go

@@ -41,9 +41,11 @@ func ObjectList[T any](ctx context.Context, values []T, objectAttributeTypes map
 	return objectList, nil
 }
 
-// TypesListToStringSlice converts a types.List to a pointer to a slice of strings
+// TypesListToStringSlicePtr converts a types.List to a pointer to a slice of strings
 // This is useful for converting a list of strings from the Terraform framework to a slice of strings used for calling the API
-func TypesListToStringSlice(list types.List) *[]string {
+// We prefer to use a pointer to a slice of strings because our API client query params usually have type *[]string
+// and we can easily assign the query param to the result of this function (regardless if the result is nil or not)
+func TypesListToStringSlicePtr(list types.List) *[]string {
 	elements := list.Elements()
 	if len(elements) == 0 {
 		return nil