make docs

cloudflare · Apr 19, 2023 · 927073a · 927073a
1 parent ee2de59
commit 927073a
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 4 deletions.
diff --git a/docs/resources/ruleset.md b/docs/resources/ruleset.md
@@ -427,7 +427,12 @@ resource "cloudflare_ruleset" "response_compress_brotli_html" {
   rules {
     action = "compress_response"
     action_parameters {
-      algorithms = [ { name: "brotli" }, { name: "default" } ]
+      algorithms {
+        name = "brotli"
+      }
+      algorithms {
+        name = "default"
+      }
     }
     expression  = "http.response.content_type.media_type == \"text/html\""
     description = "Prefer brotli compression for HTML"
@@ -537,7 +542,7 @@ Optional:
 
 Required:
 
-- `name` (String) Name of the compression algorithm to use.
+- `name` (String) Name of the compression algorithm to use. Available values: `gzip`, `brotli`, `default`, `none`
 
 
 <a id="nestedblock--rules--action_parameters--autominify"></a>

diff --git a/examples/resources/cloudflare_ruleset/resource.tf b/examples/resources/cloudflare_ruleset/resource.tf
@@ -395,7 +395,12 @@ resource "cloudflare_ruleset" "response_compress_brotli_html" {
   rules {
     action = "compress_response"
     action_parameters {
-      algorithms = [ { name: "brotli" }, { name: "default" } ]
+      algorithms {
+        name = "brotli"
+      }
+      algorithms {
+        name = "default"
+      }
     }
     expression  = "http.response.content_type.media_type == \"text/html\""
     description = "Prefer brotli compression for HTML"

diff --git a/internal/framework/service/rulesets/schema.go b/internal/framework/service/rulesets/schema.go
@@ -305,7 +305,7 @@ func (r *RulesetResource) Schema(ctx context.Context, req resource.SchemaRequest
 											Attributes: map[string]schema.Attribute{
 												"name": schema.StringAttribute{
 													Required:            true,
-													MarkdownDescription: "Name of the compression algorithm to use.",
+													MarkdownDescription: fmt.Sprintf("Name of the compression algorithm to use. %s", utils.RenderAvailableDocumentationValuesStringSlice([]string{"gzip", "brotli", "default", "none"})),
 													Validators: []validator.String{
 														stringvalidator.OneOf("gzip", "brotli", "default", "none"),
 													},