From 7a9dce29f7127a61a1ad15200d4f7b0783396617 Mon Sep 17 00:00:00 2001 From: Cyb3r-Jak3 Date: Sat, 14 Oct 2023 09:05:11 -0400 Subject: [PATCH 1/2] Make a note about logging only being supported with skip action --- .changelog/2851.txt | 3 +++ docs/resources/ruleset.md | 2 +- internal/framework/service/rulesets/schema.go | 2 +- 3 files changed, 5 insertions(+), 2 deletions(-) create mode 100644 .changelog/2851.txt diff --git a/.changelog/2851.txt b/.changelog/2851.txt new file mode 100644 index 0000000000..eeaf3de725 --- /dev/null +++ b/.changelog/2851.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/ruleset: Add note that logging is only supported with the skip action +``` diff --git a/docs/resources/ruleset.md b/docs/resources/ruleset.md index bb19333b0d..c18843d184 100644 --- a/docs/resources/ruleset.md +++ b/docs/resources/ruleset.md @@ -467,7 +467,7 @@ Optional: - `description` (String) Brief summary of the ruleset rule and its intended use. - `enabled` (Boolean) Whether the rule is active. - `exposed_credential_check` (Block List) List of parameters that configure exposed credential checks. (see [below for nested schema](#nestedblock--rules--exposed_credential_check)) -- `logging` (Block List) List parameters to configure how the rule generates logs. (see [below for nested schema](#nestedblock--rules--logging)) +- `logging` (Block List) List parameters to configure how the rule generates logs. Only valid for skip action. (see [below for nested schema](#nestedblock--rules--logging)) - `ratelimit` (Block List) List of parameters that configure HTTP rate limiting behaviour. (see [below for nested schema](#nestedblock--rules--ratelimit)) - `ref` (String) Rule reference. diff --git a/internal/framework/service/rulesets/schema.go b/internal/framework/service/rulesets/schema.go index 9a57434594..6ae5f60ed7 100644 --- a/internal/framework/service/rulesets/schema.go +++ b/internal/framework/service/rulesets/schema.go @@ -945,7 +945,7 @@ func (r *RulesetResource) Schema(ctx context.Context, req resource.SchemaRequest }, }, "logging": schema.ListNestedBlock{ - MarkdownDescription: "List parameters to configure how the rule generates logs.", + MarkdownDescription: "List parameters to configure how the rule generates logs. Only valid for skip action.", NestedObject: schema.NestedBlockObject{ Attributes: map[string]schema.Attribute{ "enabled": schema.BoolAttribute{ From 319c887c94bd06ea9a4144d71ded64114b675627 Mon Sep 17 00:00:00 2001 From: Jacob Bednarz Date: Mon, 16 Oct 2023 11:24:41 +1100 Subject: [PATCH 2/2] upda --- .changelog/2851.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.changelog/2851.txt b/.changelog/2851.txt index eeaf3de725..8f8ceb7ca1 100644 --- a/.changelog/2851.txt +++ b/.changelog/2851.txt @@ -1,3 +1,3 @@ ```release-note:bug -resource/ruleset: Add note that logging is only supported with the skip action +resource/cloudflare_ruleset: Add note that logging is only supported with the skip action ```