Add required field checks for postgres resource IDs

pietern · claude · pietern · commit f6c4af246626 · 2026-02-04T11:07:21.000+01:00
Changes the postgres resource ID fields (project_id, branch_id, endpoint_id)
from optional to required, matching the API's behavior. Previously these fields
were marked as omitempty but the API requires them for resource creation.

Changes:
- Mark project_id, branch_id, endpoint_id, and parent fields as required in bundle config
- Remove manual validation from direct deployment code (now handled by config validation)
- Update generated required_fields.go and JSON schema
- Add validation in test server to return 400 errors matching real API behavior
- Update acceptance test outputs to reflect new warning messages and error responses

The test server now properly validates required ID fields and returns the same
error message as the real API: "Field 'X' is required, expected non-default value (not \"\")!"

All acceptance tests pass both locally and against real AWS workspace.

Co-Authored-By: Claude Sonnet 4.5 &lt;noreply@anthropic.com&gt;
diff --git a/acceptance/bundle/resources/postgres_branches/without_branch_id/out.deploy.direct.txt b/acceptance/bundle/resources/postgres_branches/without_branch_id/out.deploy.direct.txt
@@ -1,5 +1,14 @@
+Warning: required field "branch_id" is not set
+  at resources.postgres_branches.main
+  in databricks.yml:21:7
+
 Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/deploy-postgres-branch-no-id-[UNIQUE_NAME]/default/files...
 Deploying resources...
-Error: cannot create resources.postgres_branches.main: branch_id must be specified
+Error: cannot create resources.postgres_branches.main: Field 'branch_id' is required, expected non-default value (not "")! (400 INVALID_PARAMETER_VALUE)
+
+Endpoint: POST [DATABRICKS_URL]/api/2.0/postgres/projects/test-pg-proj-[UNIQUE_NAME]/branches
+HTTP Status: 400 Bad Request
+API error_code: INVALID_PARAMETER_VALUE
+API message: Field 'branch_id' is required, expected non-default value (not "")!
 
 Updating deployment state...
diff --git a/acceptance/bundle/resources/postgres_branches/without_branch_id/out.deploy.terraform.txt b/acceptance/bundle/resources/postgres_branches/without_branch_id/out.deploy.terraform.txt
@@ -1,3 +1,7 @@
+Warning: required field "branch_id" is not set
+  at resources.postgres_branches.main
+  in databricks.yml:21:7
+
 Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/deploy-postgres-branch-no-id-[UNIQUE_NAME]/default/files...
 Error: exit status 1
 
diff --git a/acceptance/bundle/resources/postgres_branches/without_branch_id/output.txt b/acceptance/bundle/resources/postgres_branches/without_branch_id/output.txt
@@ -1,9 +1,13 @@
 
 >>> [CLI] bundle validate
+Warning: required field "branch_id" is not set
+  at resources.postgres_branches.main
+  in databricks.yml:21:7
+
 Name: deploy-postgres-branch-no-id-[UNIQUE_NAME]
 Target: default
 Workspace:
   User: [USERNAME]
   Path: /Workspace/Users/[USERNAME]/.bundle/deploy-postgres-branch-no-id-[UNIQUE_NAME]/default
 
-Validation OK!
+Found 1 warning
diff --git a/acceptance/bundle/resources/postgres_endpoints/without_endpoint_id/out.deploy.direct.txt b/acceptance/bundle/resources/postgres_endpoints/without_endpoint_id/out.deploy.direct.txt
@@ -1,5 +1,14 @@
+Warning: required field "endpoint_id" is not set
+  at resources.postgres_endpoints.primary
+  in databricks.yml:27:7
+
 Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/deploy-postgres-endpoint-no-id-[UNIQUE_NAME]/default/files...
 Deploying resources...
-Error: cannot create resources.postgres_endpoints.primary: endpoint_id must be specified
+Error: cannot create resources.postgres_endpoints.primary: Field 'endpoint_id' is required, expected non-default value (not "")! (400 INVALID_PARAMETER_VALUE)
+
+Endpoint: POST [DATABRICKS_URL]/api/2.0/postgres/projects/test-pg-proj-[UNIQUE_NAME]/branches/main/endpoints
+HTTP Status: 400 Bad Request
+API error_code: INVALID_PARAMETER_VALUE
+API message: Field 'endpoint_id' is required, expected non-default value (not "")!
 
 Updating deployment state...
diff --git a/acceptance/bundle/resources/postgres_endpoints/without_endpoint_id/out.deploy.terraform.txt b/acceptance/bundle/resources/postgres_endpoints/without_endpoint_id/out.deploy.terraform.txt
@@ -1,3 +1,7 @@
+Warning: required field "endpoint_id" is not set
+  at resources.postgres_endpoints.primary
+  in databricks.yml:27:7
+
 Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/deploy-postgres-endpoint-no-id-[UNIQUE_NAME]/default/files...
 Error: exit status 1
 
diff --git a/acceptance/bundle/resources/postgres_endpoints/without_endpoint_id/output.txt b/acceptance/bundle/resources/postgres_endpoints/without_endpoint_id/output.txt
@@ -1,9 +1,13 @@
 
 >>> [CLI] bundle validate
+Warning: required field "endpoint_id" is not set
+  at resources.postgres_endpoints.primary
+  in databricks.yml:27:7
+
 Name: deploy-postgres-endpoint-no-id-[UNIQUE_NAME]
 Target: default
 Workspace:
   User: [USERNAME]
   Path: /Workspace/Users/[USERNAME]/.bundle/deploy-postgres-endpoint-no-id-[UNIQUE_NAME]/default
 
-Validation OK!
+Found 1 warning
diff --git a/acceptance/bundle/resources/postgres_projects/without_project_id/out.deploy.direct.txt b/acceptance/bundle/resources/postgres_projects/without_project_id/out.deploy.direct.txt
@@ -1,5 +1,14 @@
+Warning: required field "project_id" is not set
+  at resources.postgres_projects.my_project
+  in databricks.yml:10:7
+
 Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/deploy-postgres-no-id-[UNIQUE_NAME]/default/files...
 Deploying resources...
-Error: cannot create resources.postgres_projects.my_project: project_id must be specified
+Error: cannot create resources.postgres_projects.my_project: Field 'project_id' is required, expected non-default value (not "")! (400 INVALID_PARAMETER_VALUE)
+
+Endpoint: POST [DATABRICKS_URL]/api/2.0/postgres/projects
+HTTP Status: 400 Bad Request
+API error_code: INVALID_PARAMETER_VALUE
+API message: Field 'project_id' is required, expected non-default value (not "")!
 
 Updating deployment state...
diff --git a/acceptance/bundle/resources/postgres_projects/without_project_id/out.deploy.terraform.txt b/acceptance/bundle/resources/postgres_projects/without_project_id/out.deploy.terraform.txt
@@ -1,3 +1,7 @@
+Warning: required field "project_id" is not set
+  at resources.postgres_projects.my_project
+  in databricks.yml:10:7
+
 Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/deploy-postgres-no-id-[UNIQUE_NAME]/default/files...
 Error: exit status 1
 
diff --git a/acceptance/bundle/resources/postgres_projects/without_project_id/output.txt b/acceptance/bundle/resources/postgres_projects/without_project_id/output.txt
@@ -1,9 +1,13 @@
 
 >>> [CLI] bundle validate
+Warning: required field "project_id" is not set
+  at resources.postgres_projects.my_project
+  in databricks.yml:10:7
+
 Name: deploy-postgres-no-id-[UNIQUE_NAME]
 Target: default
 Workspace:
   User: [USERNAME]
   Path: /Workspace/Users/[USERNAME]/.bundle/deploy-postgres-no-id-[UNIQUE_NAME]/default
 
-Validation OK!
+Found 1 warning
diff --git a/bundle/config/resources/postgres_branch.go b/bundle/config/resources/postgres_branch.go
@@ -14,11 +14,11 @@ type PostgresBranch struct {
 	postgres.BranchSpec
 
 	// Parent is the project containing this branch. Format: "projects/{project_id}"
-	Parent string `json:"parent,omitempty"`
+	Parent string `json:"parent"`
 
 	// BranchId is the user-specified ID for the branch (becomes part of the hierarchical name).
 	// This is specified during creation and becomes part of Name: "projects/{project_id}/branches/{branch_id}"
-	BranchId string `json:"branch_id,omitempty"`
+	BranchId string `json:"branch_id"`
 
 	// Name is the hierarchical resource name (output-only). Format: "projects/{project_id}/branches/{branch_id}"
 	Name string `json:"name,omitempty" bundle:"readonly"`
diff --git a/bundle/config/resources/postgres_endpoint.go b/bundle/config/resources/postgres_endpoint.go
@@ -14,11 +14,11 @@ type PostgresEndpoint struct {
 	postgres.EndpointSpec
 
 	// Parent is the branch containing this endpoint. Format: "projects/{project_id}/branches/{branch_id}"
-	Parent string `json:"parent,omitempty"`
+	Parent string `json:"parent"`
 
 	// EndpointId is the user-specified ID for the endpoint (becomes part of the hierarchical name).
 	// This is specified during creation and becomes part of Name: "projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}"
-	EndpointId string `json:"endpoint_id,omitempty"`
+	EndpointId string `json:"endpoint_id"`
 
 	// Name is the hierarchical resource name (output-only). Format: "projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}"
 	Name string `json:"name,omitempty" bundle:"readonly"`
diff --git a/bundle/config/resources/postgres_project.go b/bundle/config/resources/postgres_project.go
@@ -15,7 +15,7 @@ type PostgresProject struct {
 
 	// ProjectId is the user-specified ID for the project (becomes part of the hierarchical name).
 	// This is specified during creation and becomes part of Name: "projects/{project_id}"
-	ProjectId string `json:"project_id,omitempty"`
+	ProjectId string `json:"project_id"`
 
 	// Name is the hierarchical resource name (output-only). Format: "projects/{project_id}"
 	Name string `json:"name,omitempty" bundle:"readonly"`
diff --git a/bundle/direct/dresources/postgres_branch.go b/bundle/direct/dresources/postgres_branch.go
@@ -2,7 +2,6 @@ package dresources
 
 import (
 	"context"
-	"errors"
 
 	"github.com/databricks/cli/bundle/config/resources"
 	"github.com/databricks/databricks-sdk-go"
@@ -64,19 +63,9 @@ func (r *ResourcePostgresBranch) DoRead(ctx context.Context, id string) (*postgr
 }
 
 func (r *ResourcePostgresBranch) DoCreate(ctx context.Context, config *PostgresBranchState) (string, *postgres.Branch, error) {
-	branchId := config.BranchId
-	if branchId == "" {
-		return "", nil, errors.New("branch_id must be specified")
-	}
-
-	parent := config.Parent
-	if parent == "" {
-		return "", nil, errors.New("parent (project name) must be specified")
-	}
-
 	waiter, err := r.client.Postgres.CreateBranch(ctx, postgres.CreateBranchRequest{
-		BranchId: branchId,
-		Parent:   parent,
+		BranchId: config.BranchId,
+		Parent:   config.Parent,
 		Branch: postgres.Branch{
 			Spec: config.Spec,
 
diff --git a/bundle/direct/dresources/postgres_endpoint.go b/bundle/direct/dresources/postgres_endpoint.go
@@ -101,19 +101,9 @@ func (r *ResourcePostgresEndpoint) waitForReconciliation(ctx context.Context, na
 }
 
 func (r *ResourcePostgresEndpoint) DoCreate(ctx context.Context, config *PostgresEndpointState) (string, *postgres.Endpoint, error) {
-	endpointId := config.EndpointId
-	if endpointId == "" {
-		return "", nil, errors.New("endpoint_id must be specified")
-	}
-
-	parent := config.Parent
-	if parent == "" {
-		return "", nil, errors.New("parent (branch name) must be specified")
-	}
-
 	waiter, err := r.client.Postgres.CreateEndpoint(ctx, postgres.CreateEndpointRequest{
-		EndpointId: endpointId,
-		Parent:     parent,
+		EndpointId: config.EndpointId,
+		Parent:     config.Parent,
 		Endpoint: postgres.Endpoint{
 			Spec: config.Spec,
 
diff --git a/bundle/direct/dresources/postgres_project.go b/bundle/direct/dresources/postgres_project.go
@@ -2,7 +2,6 @@ package dresources
 
 import (
 	"context"
-	"errors"
 
 	"github.com/databricks/cli/bundle/config/resources"
 	"github.com/databricks/databricks-sdk-go"
@@ -58,13 +57,8 @@ func (r *ResourcePostgresProject) DoRead(ctx context.Context, id string) (*postg
 }
 
 func (r *ResourcePostgresProject) DoCreate(ctx context.Context, config *PostgresProjectState) (string, *postgres.Project, error) {
-	projectId := config.ProjectId
-	if projectId == "" {
-		return "", nil, errors.New("project_id must be specified")
-	}
-
 	waiter, err := r.client.Postgres.CreateProject(ctx, postgres.CreateProjectRequest{
-		ProjectId: projectId,
+		ProjectId: config.ProjectId,
 		Project: postgres.Project{
 			Spec: config.Spec,
 
diff --git a/bundle/internal/validation/generated/required_fields.go b/bundle/internal/validation/generated/required_fields.go
diff --git a/bundle/schema/jsonschema.json b/bundle/schema/jsonschema.json
diff --git a/libs/testserver/postgres.go b/libs/testserver/postgres.go
@@ -15,15 +15,13 @@ func nowTime() *sdktime.Time {
 	return sdktime.New(time.Now().UTC())
 }
 
-// postgresErrorResponse creates an error response with error code and trace ID for postgres API.
-// The trace ID is included directly in the message to match the real API behavior.
+// postgresErrorResponse creates an error response with error code for postgres API.
 func postgresErrorResponse(statusCode int, errorCode, message string) Response {
-	traceID := fmt.Sprintf("%x", nextID())
 	return Response{
 		StatusCode: statusCode,
 		Body: map[string]string{
 			"error_code": errorCode,
-			"message":    fmt.Sprintf("%s [TraceId: %s]", message, traceID),
+			"message":    message,
 		},
 	}
 }
@@ -37,6 +35,11 @@ func postgresNotFoundResponse(resourceType string) Response {
 func (s *FakeWorkspace) PostgresProjectCreate(req Request, projectID string) Response {
 	defer s.LockUnlock()()
 
+	// Validate that project_id is provided
+	if projectID == "" {
+		return postgresErrorResponse(400, "INVALID_PARAMETER_VALUE", `Field 'project_id' is required, expected non-default value (not "")!`)
+	}
+
 	var project postgres.Project
 	if len(req.Body) > 0 {
 		if err := json.Unmarshal(req.Body, &project); err != nil {
@@ -189,6 +192,11 @@ func (s *FakeWorkspace) PostgresProjectDelete(name string) Response {
 func (s *FakeWorkspace) PostgresBranchCreate(req Request, parent, branchID string) Response {
 	defer s.LockUnlock()()
 
+	// Validate that branch_id is provided
+	if branchID == "" {
+		return postgresErrorResponse(400, "INVALID_PARAMETER_VALUE", `Field 'branch_id' is required, expected non-default value (not "")!`)
+	}
+
 	// Check if parent project exists
 	if _, exists := s.PostgresProjects[parent]; !exists {
 		return postgresNotFoundResponse("project")
@@ -362,6 +370,11 @@ func (s *FakeWorkspace) PostgresBranchDelete(name string) Response {
 func (s *FakeWorkspace) PostgresEndpointCreate(req Request, parent, endpointID string) Response {
 	defer s.LockUnlock()()
 
+	// Validate that endpoint_id is provided
+	if endpointID == "" {
+		return postgresErrorResponse(400, "INVALID_PARAMETER_VALUE", `Field 'endpoint_id' is required, expected non-default value (not "")!`)
+	}
+
 	// Check if parent branch exists
 	branch, exists := s.PostgresBranches[parent]
 	if !exists {
