Merge pull request #1060 from hashicorp/mkam/TF-24090/default-project-nullable

Support unsetting an organization's default project

Author: mkam

go.mod

@@ -9,7 +9,7 @@ require (
 	github.com/hashicorp/go-slug v0.16.4
 	github.com/hashicorp/go-uuid v1.0.3
 	github.com/hashicorp/go-version v1.7.0
-	github.com/hashicorp/jsonapi v1.4.1
+	github.com/hashicorp/jsonapi v1.4.3-0.20250220162346-81a76b606f3e
 	github.com/stretchr/testify v1.10.0
 	go.uber.org/mock v0.4.0
 	golang.org/x/sync v0.10.0

go.sum

@@ -16,8 +16,8 @@ github.com/hashicorp/go-uuid v1.0.3 h1:2gKiV6YVmrJ1i2CKKa9obLvRieoRGviZFL26PcT/C
 github.com/hashicorp/go-uuid v1.0.3/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro=
 github.com/hashicorp/go-version v1.7.0 h1:5tqGy27NaOTB8yJKUZELlFAS/LTKJkrmONwQKeRZfjY=
 github.com/hashicorp/go-version v1.7.0/go.mod h1:fltr4n8CU8Ke44wwGCBoEymUuxUHl09ZGVZPK5anwXA=
-github.com/hashicorp/jsonapi v1.4.1 h1:U6CZvnS70Sg7im0kpfhWAoF3NasLumaMndQhEWniHZA=
-github.com/hashicorp/jsonapi v1.4.1/go.mod h1:kWfdn49yCjQvbpnvY1dxxAuAFzISwrrMDQOcu6NsFoM=
+github.com/hashicorp/jsonapi v1.4.3-0.20250220162346-81a76b606f3e h1:xwy/1T0cxHWaLx2MM0g4BlaQc1BXn/9835mPrBqwSPU=
+github.com/hashicorp/jsonapi v1.4.3-0.20250220162346-81a76b606f3e/go.mod h1:kWfdn49yCjQvbpnvY1dxxAuAFzISwrrMDQOcu6NsFoM=
 github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA=
 github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=

organization.go

@@ -8,6 +8,8 @@ import (
 	"fmt"
 	"net/url"
 	"time"
+
+	"github.com/hashicorp/jsonapi"
 )
 
 // Compile-time proof of interface implementation.
@@ -314,7 +316,7 @@ type OrganizationUpdateOptions struct {
 
 	// Optional: DefaultProject is the default project that workspaces are created in when no project is specified.
 	// This setting is considered BETA, SUBJECT TO CHANGE, and likely unavailable to most users.
-	DefaultProject *Project `jsonapi:"relation,default-project,omitempty"`
+	DefaultProject jsonapi.NullableRelationship[*Project] `jsonapi:"relation,default-project,omitempty"`
 }
 
 // ReadRunQueueOptions represents the options for showing the queue.

organization_integration_test.go

@@ -10,6 +10,7 @@ import (
 	"testing"
 	"time"
 
+	"github.com/hashicorp/jsonapi"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
@@ -400,14 +401,34 @@ func TestOrganizationsUpdate(t *testing.T) {
 
 		// Update the default project and verify the change
 		updated, err := client.Organizations.Update(ctx, org.Name, OrganizationUpdateOptions{
-			DefaultProject: proj,
+			DefaultProject: jsonapi.NewNullableRelationshipWithValue[*Project](proj),
 		})
 		require.NoError(t, err)
 		require.Equal(t, proj.ID, updated.DefaultProject.ID)
 
 		fetched, err := client.Organizations.Read(ctx, org.Name)
 		require.NoError(t, err)
 		require.Equal(t, proj.ID, fetched.DefaultProject.ID)
+
+		// Update without setting default project and verify no changes
+		updated, err = client.Organizations.Update(ctx, org.Name, OrganizationUpdateOptions{})
+		require.NoError(t, err)
+		require.Equal(t, proj.ID, updated.DefaultProject.ID)
+
+		fetched, err = client.Organizations.Read(ctx, org.Name)
+		require.NoError(t, err)
+		require.Equal(t, proj.ID, fetched.DefaultProject.ID)
+
+		// Update the setting to an explicit null value and verify it is unset
+		deleted, err := client.Organizations.Update(ctx, org.Name, OrganizationUpdateOptions{
+			DefaultProject: jsonapi.NewNullNullableRelationship[*Project](),
+		})
+		require.NoError(t, err)
+		require.Nil(t, deleted.DefaultProject)
+
+		fetched, err = client.Organizations.Read(ctx, org.Name)
+		require.NoError(t, err)
+		require.Nil(t, fetched.DefaultProject)
 	})
 }