docs: proposed changes to local resources documentation schema

d-strobel · Oct 21, 2024 · 8d6501a · 8d6501a
1 parent 9af9aaf
commit 8d6501a
Showing 1 changed file with 17 additions and 4 deletions.
diff --git a/internal/schema/local_resources.json b/internal/schema/local_resources.json
@@ -55,7 +55,7 @@
             "name": "name",
             "string": {
               "computed_optional_required": "required",
-              "description": "Define the name for the local security group. The maximum length is 256 characters.",
+              "description": "Define the name for the local security group. The maximum length is 256 characters. A local security group name can't contain the following characters: `\"`, `/`, `\\`, `[`, `]`, `:`, `;`, `|`, `=`, `,`, `+`, `*`, `?`, `<`, `>`, `@`",
               "validators": [
                 {
                   "custom": {
@@ -66,6 +66,19 @@
                     ],
                     "schema_definition": "stringvalidator.LengthBetween(1, 256)"
                   }
+                },
+                {
+                  "custom": {
+                    "imports": [
+                      {
+                        "path": "github.com/hashicorp/terraform-plugin-framework-validators/stringvalidator"
+                      },
+                      {
+                        "path": "regexp"
+                      }
+                    ],
+                    "schema_definition": "stringvalidator.RegexMatches(regexp.MustCompile(`^[^\"/\\[\\]:;|=,+*?<>\\@]+$`), `cannot contain the following characters: \"/\\[]:;|=,+*?<>@ `)"
+                  }
                 }
               ],
               "plan_modifiers": [
@@ -228,7 +241,7 @@
                         "path": "regexp"
                       }
                     ],
-                    "schema_definition": "stringvalidator.RegexMatches(regexp.MustCompile(`^[^\"\/\\[\\]:;|=,+*?<>\\@]+$`), `cannot contain the following characters: \"/\\[]:;|=,+*?<>@ `)"
+                    "schema_definition": "stringvalidator.RegexMatches(regexp.MustCompile(`^[^\"/\\[\\]:;|=,+*?<>\\@]+$`), `cannot contain the following characters: \"/\\[]:;|=,+*?<>@ `)"
                   }
                 }
               ],
@@ -360,8 +373,8 @@
     {
       "name": "local_group_member",
       "schema": {
-        "description": "Manage group member for local security groups.",
-        "markdown_description": "Manage group member for local security groups.",
+        "description": "Manage members of local security groups.",
+        "markdown_description": "Manage members of local security groups.",
         "attributes": [
           {
             "name": "group_id",