docs: updates following review

matt-FFFFFF · matt-FFFFFF · commit 6c4f815b7d36 · 2025-01-31T15:47:35.000Z
diff --git a/docs/data-sources/resource.md b/docs/data-sources/resource.md
@@ -136,7 +136,7 @@ To learn more about JMESPath, visit [JMESPath](https://jmespath.org/).
 
 Optional:
 
-- `error_message_regex` (List of String)
+- `error_message_regex` (List of String) A list of regular expressions to match against error messages. If any of the regular expressions match, the request will be retried.
 - `interval_seconds` (Number) The base number of seconds to wait between retries. Default is `10`.
 - `max_interval_seconds` (Number) The maximum number of seconds to wait between retries. Default is `180`.
 - `multiplier` (Number) The multiplier to apply to the interval between retries. Default is `1.5`.
diff --git a/docs/data-sources/resource_action.md b/docs/data-sources/resource_action.md
@@ -154,7 +154,7 @@ To learn more about JMESPath, visit [JMESPath](https://jmespath.org/).
 
 Optional:
 
-- `error_message_regex` (List of String)
+- `error_message_regex` (List of String) A list of regular expressions to match against error messages. If any of the regular expressions match, the request will be retried.
 - `interval_seconds` (Number) The base number of seconds to wait between retries. Default is `10`.
 - `max_interval_seconds` (Number) The maximum number of seconds to wait between retries. Default is `180`.
 - `multiplier` (Number) The multiplier to apply to the interval between retries. Default is `1.5`.
diff --git a/docs/data-sources/resource_list.md b/docs/data-sources/resource_list.md
@@ -138,7 +138,7 @@ To learn more about JMESPath, visit [JMESPath](https://jmespath.org/).
 
 Optional:
 
-- `error_message_regex` (List of String)
+- `error_message_regex` (List of String) A list of regular expressions to match against error messages. If any of the regular expressions match, the request will be retried.
 - `interval_seconds` (Number) The base number of seconds to wait between retries. Default is `10`.
 - `max_interval_seconds` (Number) The maximum number of seconds to wait between retries. Default is `180`.
 - `multiplier` (Number) The multiplier to apply to the interval between retries. Default is `1.5`.
diff --git a/docs/ephemeral-resources/resource_action.md b/docs/ephemeral-resources/resource_action.md
@@ -123,7 +123,7 @@ To learn more about JMESPath, visit [JMESPath](https://jmespath.org/).
 
 Optional:
 
-- `error_message_regex` (List of String)
+- `error_message_regex` (List of String) A list of regular expressions to match against error messages. If any of the regular expressions match, the request will be retried.
 - `interval_seconds` (Number) The base number of seconds to wait between retries. Default is `10`.
 - `max_interval_seconds` (Number) The maximum number of seconds to wait between retries. Default is `180`.
 - `multiplier` (Number) The multiplier to apply to the interval between retries. Default is `1.5`.
diff --git a/docs/guides/retry-configuration.md b/docs/guides/retry-configuration.md
@@ -41,6 +41,7 @@ If you configure a retry configuration, the maximum elapsed time for the retry w
 
 The schema of these retry attributes is as follows:
 
+- `error_message_regex` - A list of regular expressions to match against error messages. If any of the regular expressions match, the request will be retried.
 - `interval_seconds` - The initial number of seconds to wait before the 1st retry. The default value is `10`.
 - `max_interval_seconds` - The maximum number of times to retry the request. The default value is `180`.
 - `multiplier` - The multiplier to apply to the interval between retries. The default value is `1.5`.
diff --git a/docs/resources/data_plane_resource.md b/docs/resources/data_plane_resource.md
@@ -165,7 +165,7 @@ To learn more about JMESPath, visit [JMESPath](https://jmespath.org/).
 
 Optional:
 
-- `error_message_regex` (List of String)
+- `error_message_regex` (List of String) A list of regular expressions to match against error messages. If any of the regular expressions match, the request will be retried.
 - `interval_seconds` (Number) The base number of seconds to wait between retries. Default is `10`.
 - `max_interval_seconds` (Number) The maximum number of seconds to wait between retries. Default is `180`.
 - `multiplier` (Number) The multiplier to apply to the interval between retries. Default is `1.5`.
@@ -180,7 +180,7 @@ Optional:
 
 Optional:
 
-- `error_message_regex` (List of String)
+- `error_message_regex` (List of String) A list of regular expressions to match against error messages. If any of the regular expressions match, the request will be retried.
 - `interval_seconds` (Number) The base number of seconds to wait between retries. Default is `10`.
 - `max_interval_seconds` (Number) The maximum number of seconds to wait between retries. Default is `180`.
 - `multiplier` (Number) The multiplier to apply to the interval between retries. Default is `1.5`.
diff --git a/docs/resources/resource.md b/docs/resources/resource.md
@@ -209,7 +209,7 @@ Read-Only:
 
 Optional:
 
-- `error_message_regex` (List of String)
+- `error_message_regex` (List of String) A list of regular expressions to match against error messages. If any of the regular expressions match, the request will be retried.
 - `interval_seconds` (Number) The base number of seconds to wait between retries. Default is `10`.
 - `max_interval_seconds` (Number) The maximum number of seconds to wait between retries. Default is `180`.
 - `multiplier` (Number) The multiplier to apply to the interval between retries. Default is `1.5`.
@@ -224,7 +224,7 @@ Optional:
 
 Optional:
 
-- `error_message_regex` (List of String)
+- `error_message_regex` (List of String) A list of regular expressions to match against error messages. If any of the regular expressions match, the request will be retried.
 - `interval_seconds` (Number) The base number of seconds to wait between retries. Default is `10`.
 - `max_interval_seconds` (Number) The maximum number of seconds to wait between retries. Default is `180`.
 - `multiplier` (Number) The multiplier to apply to the interval between retries. Default is `1.5`.
diff --git a/docs/resources/resource_action.md b/docs/resources/resource_action.md
@@ -175,7 +175,7 @@ To learn more about JMESPath, visit [JMESPath](https://jmespath.org/).
 
 Optional:
 
-- `error_message_regex` (List of String)
+- `error_message_regex` (List of String) A list of regular expressions to match against error messages. If any of the regular expressions match, the request will be retried.
 - `interval_seconds` (Number) The base number of seconds to wait between retries. Default is `10`.
 - `max_interval_seconds` (Number) The maximum number of seconds to wait between retries. Default is `180`.
 - `multiplier` (Number) The multiplier to apply to the interval between retries. Default is `1.5`.
diff --git a/docs/resources/update_resource.md b/docs/resources/update_resource.md
@@ -167,7 +167,7 @@ To learn more about JMESPath, visit [JMESPath](https://jmespath.org/).
 
 Optional:
 
-- `error_message_regex` (List of String)
+- `error_message_regex` (List of String) A list of regular expressions to match against error messages. If any of the regular expressions match, the request will be retried.
 - `interval_seconds` (Number) The base number of seconds to wait between retries. Default is `10`.
 - `max_interval_seconds` (Number) The maximum number of seconds to wait between retries. Default is `180`.
 - `multiplier` (Number) The multiplier to apply to the interval between retries. Default is `1.5`.
diff --git a/internal/retry/ir.json b/internal/retry/ir.json
@@ -103,6 +103,7 @@
                 {
                   "name": "error_message_regex",
                   "list": {
+                    "description": "A list of regular expressions to match against error messages. If any of the regular expressions match, the request will be retried.",
                     "element_type": {
                       "string": {}
                     },
diff --git a/internal/retry/schema.go b/internal/retry/schema.go
@@ -18,8 +18,9 @@ func RetrySchema(ctx context.Context) schema.Attribute {
 	return schema.SingleNestedAttribute{
 		Attributes: map[string]schema.Attribute{
 			"error_message_regex": schema.ListAttribute{
-				ElementType: types.StringType,
-				Optional:    true,
+				ElementType:         types.StringType,
+				Optional:            true,
+				MarkdownDescription: "A list of regular expressions to match against error messages. If any of the regular expressions match, the request will be retried.",
 				Validators: []validator.List{
 					listvalidator.ValueStringsAre(myvalidator.StringIsValidRegex()),
 					listvalidator.UniqueValues(),
diff --git a/templates/guides/retry-configuration.md b/templates/guides/retry-configuration.md
@@ -41,6 +41,7 @@ If you configure a retry configuration, the maximum elapsed time for the retry w
 
 The schema of these retry attributes is as follows:
 
+- `error_message_regex` - A list of regular expressions to match against error messages. If any of the regular expressions match, the request will be retried.
 - `interval_seconds` - The initial number of seconds to wait before the 1st retry. The default value is `10`.
 - `max_interval_seconds` - The maximum number of times to retry the request. The default value is `180`.
 - `multiplier` - The multiplier to apply to the interval between retries. The default value is `1.5`.

Original file line number	Diff line number	Diff line change
`@@ -103,6 +103,7 @@`
`103`	`103`	`{`
`104`	`104`	`"name": "error_message_regex",`
`105`	`105`	`"list": {`
	`106`	`+ "description": "A list of regular expressions to match against error messages. If any of the regular expressions match, the request will be retried.",`
`106`	`107`	`"element_type": {`
`107`	`108`	`"string": {}`
`108`	`109`	`},`