feat: add approval template id field for Bytebase 3.11 compatibility (#156)

d-bytebase · claude · web-flow · commit 3f155117b484 · 2025-10-10T20:06:51.000-07:00
* feat: add approval template id field for Bytebase 3.12 compatibility Add support for the new ApprovalTemplate.id field introduced in Bytebase API to support both built-in and custom approval templates. Changes: - Add required 'id' field to approval flow schema with validation - Update convertToV1ApprovalSetting to set template ID - Update flattenWorkspaceApprovalSetting to include template ID - Update Bytebase protobuf dependencies to latest version Built-in templates use 'bb.*' prefix (e.g., 'bb.project-owner', 'bb.workspace-dba'), while custom templates use UUIDs. Related: bytebase/bytebase#17689 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * test: add required id field to approval flow test cases Update all approval flow test cases to include the new required 'id' field. Use custom flow IDs (e.g., 'test-flow', 'test-ddl-approval-flow') instead of built-in 'bb.*' prefixed IDs for test cases. Fixes test failures caused by adding the required id field to ApprovalTemplate. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * docs: update examples and documentation for approval template id field Update all examples and tutorials to include the required 'id' field in approval flow configurations. Regenerate documentation to reflect the new schema changes. Changes: - Add id field to examples/setup/approval_flow.tf - Add id field to tutorials/4-3-approval-flow.tf - Regenerate docs/resources/setting.md with updated schema - Regenerate docs/data-sources/setting.md with updated schema All examples now use the built-in template ID format: 'bb.project-owner-workspace-dba-workspace-admin' 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * chore: bump version to 3.11.2 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> --------- Co-authored-by: Claude <noreply@anthropic.com>
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-3.11.1
+3.11.2
diff --git a/docs/data-sources/risk.md b/docs/data-sources/risk.md
@@ -24,7 +24,7 @@ The risk data source.
 - `active` (Boolean) The risk active.
 - `condition` (String) The risk condition.
 - `id` (String) The ID of this resource.
-- `level` (Number) The risk level.
+- `level` (String) The risk level.
 - `source` (String) The risk source.
 - `title` (String) The risk title.
 
diff --git a/docs/data-sources/risk_list.md b/docs/data-sources/risk_list.md
@@ -27,7 +27,7 @@ Read-Only:
 
 - `active` (Boolean)
 - `condition` (String)
-- `level` (Number)
+- `level` (String)
 - `name` (String)
 - `source` (String)
 - `title` (String)
diff --git a/docs/data-sources/setting.md b/docs/data-sources/setting.md
@@ -214,6 +214,7 @@ Read-Only:
 Read-Only:
 
 - `description` (String)
+- `id` (String)
 - `roles` (List of String)
 - `title` (String)
 
diff --git a/docs/resources/setting.md b/docs/resources/setting.md
@@ -55,6 +55,7 @@ Optional:
 
 Required:
 
+- `id` (String) The approval template ID. Built-in templates use 'bb.*' prefix (e.g., 'bb.project-owner', 'bb.workspace-dba'), custom templates use UUIDs.
 - `roles` (List of String) The role require to review in this step
 - `title` (String)
 
diff --git a/examples/setup/approval_flow.tf b/examples/setup/approval_flow.tf
@@ -3,6 +3,7 @@ resource "bytebase_setting" "approval_flow" {
   approval_flow {
     rules {
       flow {
+        id          = "bb.project-owner-workspace-dba-workspace-admin"
         title       = "Project Owner -> DBA -> Admin"
         description = "Need DBA and workspace admin approval"
 
diff --git a/go.mod b/go.mod
@@ -5,8 +5,8 @@ go 1.24.4
 toolchain go1.24.5
 
 require (
-	buf.build/gen/go/bytebase/bytebase/connectrpc/go v1.19.1-20251010051414-0534aa930702.1
-	buf.build/gen/go/bytebase/bytebase/protocolbuffers/go v1.36.10-20251010051414-0534aa930702.1
+	buf.build/gen/go/bytebase/bytebase/connectrpc/go v1.19.1-20251010220308-691f96ff880a.1
+	buf.build/gen/go/bytebase/bytebase/protocolbuffers/go v1.36.10-20251010220308-691f96ff880a.1
 	connectrpc.com/connect v1.19.1
 	github.com/hashicorp/go-cty v1.5.0
 	github.com/hashicorp/terraform-plugin-docs v0.13.0
diff --git a/go.sum b/go.sum
@@ -1,7 +1,7 @@
-buf.build/gen/go/bytebase/bytebase/connectrpc/go v1.19.1-20251010051414-0534aa930702.1 h1:T4v2vd8e4RkC6ccfOdsvmDZ7YnW2YyAT6OFMdwcPgOA=
-buf.build/gen/go/bytebase/bytebase/connectrpc/go v1.19.1-20251010051414-0534aa930702.1/go.mod h1:A57O99YuSmuL9rUI39AMITcbFfJc6Ikv48Qb6Y2EgCw=
-buf.build/gen/go/bytebase/bytebase/protocolbuffers/go v1.36.10-20251010051414-0534aa930702.1 h1:5bZgEFfHz4kUG6fkHH9wmBG3dxyaA5rKpaprSP0csTo=
-buf.build/gen/go/bytebase/bytebase/protocolbuffers/go v1.36.10-20251010051414-0534aa930702.1/go.mod h1:hCjM3DsxzHQGb3QEnCNYrln9ZgB16AZLOVfRJZRKC0E=
+buf.build/gen/go/bytebase/bytebase/connectrpc/go v1.19.1-20251010220308-691f96ff880a.1 h1:lHkgDYgiCUVEYxeBhBfwe53D90a/jr1kJskRHSls/WQ=
+buf.build/gen/go/bytebase/bytebase/connectrpc/go v1.19.1-20251010220308-691f96ff880a.1/go.mod h1:MQOZqauUrfWO1ApLaYR4F9cjujYikybwynvA3e0og5I=
+buf.build/gen/go/bytebase/bytebase/protocolbuffers/go v1.36.10-20251010220308-691f96ff880a.1 h1:l7ZT3ubbTddSaTBPfgGntWuhQgX/CMGGwxMRrYa6pr8=
+buf.build/gen/go/bytebase/bytebase/protocolbuffers/go v1.36.10-20251010220308-691f96ff880a.1/go.mod h1:hCjM3DsxzHQGb3QEnCNYrln9ZgB16AZLOVfRJZRKC0E=
 connectrpc.com/connect v1.19.1 h1:R5M57z05+90EfEvCY1b7hBxDVOUl45PrtXtAV2fOC14=
 connectrpc.com/connect v1.19.1/go.mod h1:tN20fjdGlewnSFeZxLKb0xwIZ6ozc3OQs2hTXy4du9w=
 dario.cat/mergo v1.0.0 h1:AGCNq9Evsj31mOgNPcLyXc+4PNABt905YmuqPYYpBWk=
diff --git a/provider/data_source_setting.go b/provider/data_source_setting.go
@@ -502,6 +502,12 @@ func getWorkspaceApprovalSetting(computed bool) *schema.Schema {
 								Type:     schema.TypeList,
 								Elem: &schema.Resource{
 									Schema: map[string]*schema.Schema{
+										"id": {
+											Type:         schema.TypeString,
+											Required:     true,
+											ValidateFunc: validation.StringIsNotEmpty,
+											Description:  "The approval template ID. Built-in templates use 'bb.*' prefix (e.g., 'bb.project-owner', 'bb.workspace-dba'), custom templates use UUIDs.",
+										},
 										"title": {
 											Type:         schema.TypeString,
 											Required:     true,
@@ -733,6 +739,7 @@ func flattenWorkspaceApprovalSetting(ctx context.Context, client api.Client, set
 			"conditions": conditionList,
 			"flow": []interface{}{
 				map[string]interface{}{
+					"id":          rule.Template.Id,
 					"title":       rule.Template.Title,
 					"description": rule.Template.Description,
 					"roles":       roleList,
diff --git a/provider/resource_setting.go b/provider/resource_setting.go
@@ -371,6 +371,7 @@ func convertToV1ApprovalSetting(d *schema.ResourceData) (*v1pb.WorkspaceApproval
 		rawFlow := flowList[0].(map[string]interface{})
 		approvalRule := &v1pb.WorkspaceApprovalSetting_Rule{
 			Template: &v1pb.ApprovalTemplate{
+				Id:          rawFlow["id"].(string),
 				Title:       rawFlow["title"].(string),
 				Description: rawFlow["description"].(string),
 				Flow:        &v1pb.ApprovalFlow{},
diff --git a/provider/resource_setting_test.go b/provider/resource_setting_test.go
@@ -226,6 +226,7 @@ resource "bytebase_setting" "%s" {
 				level  = "LOW"
 			}
 			flow {
+				id          = "test-flow"
 				title       = "Test"
 				description = "Test"
 				roles = ["roles/test"]
@@ -261,6 +262,7 @@ resource "bytebase_setting" "%s" {
 				level  = "LOW"
 			}
 			flow {
+				id          = "test-flow"
 				title       = "Test"
 				description = "Test"
 				roles = ["invalid-role"]
@@ -333,6 +335,7 @@ resource "bytebase_setting" "%s" {
 				level  = "LOW"
 			}
 			flow {
+				id          = "test-ddl-approval-flow"
 				title       = "DDL Approval Flow"
 				description = "Approval flow for DDL operations"
 				roles = [
@@ -369,6 +372,7 @@ resource "bytebase_setting" "%s" {
 				level  = "MODERATE"
 			}
 			flow {
+				id          = "test-updated-approval-flow"
 				title       = "Updated Approval Flow"
 				description = "Updated approval flow"
 				roles = [bytebase_role.approval_role_%s.name]
diff --git a/tutorials/4-3-approval-flow.tf b/tutorials/4-3-approval-flow.tf
@@ -4,6 +4,7 @@ resource "bytebase_setting" "approval_flow" {
   approval_flow {
     rules {
       flow {
+        id          = "bb.project-owner-workspace-dba-workspace-admin"
         title       = "Project Owner → DBA → Admin"
         description = "Need DBA and workspace admin approval"
         roles = [
