chore: update docs and examples for review rules (#114)

* chore: update docs and examples for review rules

* chore: update docs

Author: ecmadao

docs/data-sources/setting.md

@@ -17,7 +17,7 @@ The setting data source.
 
 ### Required
 
-- `name` (String)
+- `name` (String) The setting name in settings/{name} format. The name support "WORKSPACE_APPROVAL", "WORKSPACE_PROFILE", "DATA_CLASSIFICATION", "SEMANTIC_TYPES" and "ENVIRONMENT". Check the proto https://github.com/bytebase/bytebase/blob/main/proto/v1/v1/setting_service.proto#L109 for details
 
 ### Optional
 

docs/resources/review_config.md

@@ -37,11 +37,11 @@ Required:
 
 - `engine` (String) The rule for the database engine.
 - `level` (String) The rule level.
-- `type` (String) The rule unique type. Check https://www.bytebase.com/docs/sql-review/review-rules for all rules
+- `type` (String) The rule unique type. Check https://github.com/bytebase/bytebase/blob/main/proto/v1/v1/SQL_REVIEW_RULES_DOCUMENTATION.md#rule-categories for all rules
 
 Optional:
 
 - `comment` (String) The comment for the rule.
-- `payload` (String) The payload for the rule.
+- `payload` (String) The payload is a JSON string that varies by rule type. Check https://github.com/bytebase/bytebase/blob/main/proto/v1/v1/SQL_REVIEW_RULES_DOCUMENTATION.md#payload-structure-types for all details
 
 

docs/resources/setting.md

@@ -17,7 +17,7 @@ The setting resource.
 
 ### Required
 
-- `name` (String)
+- `name` (String) The setting name in settings/{name} format. The name support "WORKSPACE_APPROVAL", "WORKSPACE_PROFILE", "DATA_CLASSIFICATION", "SEMANTIC_TYPES" and "ENVIRONMENT". Check the proto https://github.com/bytebase/bytebase/blob/main/proto/v1/v1/setting_service.proto#L109 for details
 
 ### Optional
 

examples/setup/sql_review.tf

@@ -15,9 +15,27 @@ resource "bytebase_review_config" "sample" {
     engine = "MYSQL"
     level  = "WARNING"
   }
+  rules {
+    type    = "column.required"
+    engine  = "MYSQL"
+    level   = "ERROR"
+    payload = "{\"list\":[\"id\",\"created_ts\",\"updated_ts\",\"creator_id\",\"updater_id\"]}"
+  }
   rules {
     type   = "table.require-pk"
     engine = "MYSQL"
     level  = "ERROR"
   }
+  rules {
+    type    = "naming.column"
+    engine  = "MYSQL"
+    level   = "ERROR"
+    payload = "{\"format\":\"^[a-z]+(_[a-z]+)*$\",\"maxLength\":64}"
+  }
+  rules {
+    type    = "statement.maximum-limit-value"
+    engine  = "MYSQL"
+    level   = "ERROR"
+    payload = "{\"number\":1000}"
+  }
 }

provider/data_source_setting.go

@@ -23,8 +23,9 @@ func dataSourceSetting() *schema.Resource {
 		ReadContext: dataSourceSettingRead,
 		Schema: map[string]*schema.Schema{
 			"name": {
-				Type:     schema.TypeString,
-				Required: true,
+				Type:        schema.TypeString,
+				Required:    true,
+				Description: `The setting name in settings/{name} format. The name support "WORKSPACE_APPROVAL", "WORKSPACE_PROFILE", "DATA_CLASSIFICATION", "SEMANTIC_TYPES" and "ENVIRONMENT". Check the proto https://github.com/bytebase/bytebase/blob/main/proto/v1/v1/setting_service.proto#L109 for details`,
 				ValidateDiagFunc: internal.ResourceNameValidation(
 					regexp.MustCompile(fmt.Sprintf("^%s%s$", internal.SettingNamePrefix, v1pb.Setting_WORKSPACE_APPROVAL.String())),
 					regexp.MustCompile(fmt.Sprintf("^%s%s$", internal.SettingNamePrefix, v1pb.Setting_WORKSPACE_PROFILE.String())),

provider/resource_review_config.go

@@ -62,7 +62,7 @@ func resourceReviewConfig() *schema.Resource {
 						"type": {
 							Type:        schema.TypeString,
 							Required:    true,
-							Description: "The rule unique type. Check https://www.bytebase.com/docs/sql-review/review-rules for all rules",
+							Description: "The rule unique type. Check https://github.com/bytebase/bytebase/blob/main/proto/v1/v1/SQL_REVIEW_RULES_DOCUMENTATION.md#rule-categories for all rules",
 						},
 						"engine": {
 							Type:         schema.TypeString,
@@ -84,7 +84,7 @@ func resourceReviewConfig() *schema.Resource {
 							Type:        schema.TypeString,
 							Optional:    true,
 							Computed:    true,
-							Description: "The payload for the rule.",
+							Description: "The payload is a JSON string that varies by rule type. Check https://github.com/bytebase/bytebase/blob/main/proto/v1/v1/SQL_REVIEW_RULES_DOCUMENTATION.md#payload-structure-types for all details",
 						},
 						"comment": {
 							Type:        schema.TypeString,

provider/resource_setting.go

@@ -29,8 +29,9 @@ func resourceSetting() *schema.Resource {
 		},
 		Schema: map[string]*schema.Schema{
 			"name": {
-				Type:     schema.TypeString,
-				Required: true,
+				Type:        schema.TypeString,
+				Required:    true,
+				Description: `The setting name in settings/{name} format. The name support "WORKSPACE_APPROVAL", "WORKSPACE_PROFILE", "DATA_CLASSIFICATION", "SEMANTIC_TYPES" and "ENVIRONMENT". Check the proto https://github.com/bytebase/bytebase/blob/main/proto/v1/v1/setting_service.proto#L109 for details`,
 				ValidateDiagFunc: internal.ResourceNameValidation(
 					regexp.MustCompile(fmt.Sprintf("^%s%s$", internal.SettingNamePrefix, v1pb.Setting_WORKSPACE_APPROVAL.String())),
 					regexp.MustCompile(fmt.Sprintf("^%s%s$", internal.SettingNamePrefix, v1pb.Setting_WORKSPACE_PROFILE.String())),