Update rules-creation-workflow partial

pedrosousa · pedrosousa · commit 14a8befb5f37 · 2025-02-13T11:07:14.000Z
diff --git a/src/content/docs/rules/compression-rules/create-api.mdx b/src/content/docs/rules/compression-rules/create-api.mdx
@@ -24,7 +24,10 @@ When creating a compression rule via API, make sure you:
 
 <Render
 	file="rules-creation-workflow"
-	params={{ one: "a compression rule", two: "http_response_compression" }}
+	params={{
+		ruleName: "a compression rule",
+		phaseName: "http_response_compression",
+	}}
 />
 
 ## Examples
diff --git a/src/content/docs/rules/configuration-rules/create-api.mdx b/src/content/docs/rules/configuration-rules/create-api.mdx
@@ -7,30 +7,34 @@ sidebar:
 head:
   - tag: title
     content: Create a configuration rule via API
-
 ---
 
-import { Details, Render } from "~/components"
+import { Details, Render } from "~/components";
 
 Use the [Rulesets API](/ruleset-engine/rulesets-api/) to create configuration rules via API.
 
 ## Basic rule settings
 
 When creating a configuration rule via API, make sure you:
 
-* Set the rule action to `set_config`.
-* Define the parameters in the `action_parameters` field according to the [settings](/rules/configuration-rules/settings/) you wish to override for matching requests.
-* Deploy the rule to the `http_config_settings` phase at the zone level.
+- Set the rule action to `set_config`.
+- Define the parameters in the `action_parameters` field according to the [settings](/rules/configuration-rules/settings/) you wish to override for matching requests.
+- Deploy the rule to the `http_config_settings` phase at the zone level.
 
 ## Procedure
 
-<Render file="rules-creation-workflow" params={{ one: "a configuration rule", two: "http_config_settings" }} />
+<Render
+	file="rules-creation-workflow"
+	params={{
+		ruleName: "a configuration rule",
+		phaseName: "http_config_settings",
+	}}
+/>
 
 Make sure your API token has the [required permissions](#required-api-token-permissions) to perform the API operations.
 
 ## Example requests
 
-
 <Details header="Example: Add a rule that enables Email Obfuscation and Browser Integrity Check">
 
 The following example sets the rules of an existing phase ruleset (`{ruleset_id}`) to a single configuration rule — enabling Email Obfuscation and Browser Integrity Check for the contacts page — using the [Update a zone ruleset](/api/resources/rulesets/methods/update/) operation:
@@ -55,10 +59,8 @@ https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets/{ruleset_id} \
 }'
 ```
 
-
 </Details>
 
-
 <Details header="Example: Add a rule that turns on I'm Under Attack mode for the admin area">
 
 The following example sets the rules of an existing phase ruleset (`{ruleset_id}`) to a single configuration rule — turning on I'm Under Attack mode for the administration area — using the [Update a zone ruleset](/api/resources/rulesets/methods/update/) operation:
@@ -82,13 +84,12 @@ https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets/{ruleset_id} \
 }'
 ```
 
-
 </Details>
 
-***
+---
 
 ## Required API token permissions
 
 The API token used in API requests to manage configuration rules must have at least the following permission:
 
-* *Zone* > *Config Rules* > *Edit*
+- _Zone_ > _Config Rules_ > _Edit_
diff --git a/src/content/docs/rules/origin-rules/create-api.mdx b/src/content/docs/rules/origin-rules/create-api.mdx
@@ -24,7 +24,7 @@ When creating an origin rule via API, make sure you:
 
 <Render
 	file="rules-creation-workflow"
-	params={{ one: "an origin rule", two: "http_request_origin" }}
+	params={{ ruleName: "an origin rule", phaseName: "http_request_origin" }}
 />
 
 Make sure your API token has the [required permissions](#required-api-token-permissions) to perform the API operations.
diff --git a/src/content/docs/rules/transform/request-header-modification/create-api.mdx b/src/content/docs/rules/transform/request-header-modification/create-api.mdx
@@ -26,8 +26,8 @@ When creating an HTTP request header modification rule via API, make sure you:
 <Render
 	file="rules-creation-workflow"
 	params={{
-		one: "an HTTP request header modification rule",
-		two: "http_request_late_transform",
+		ruleName: "an HTTP request header modification rule",
+		phaseName: "http_request_late_transform",
 	}}
 />
 
diff --git a/src/content/docs/rules/transform/response-header-modification/create-api.mdx b/src/content/docs/rules/transform/response-header-modification/create-api.mdx
@@ -25,8 +25,8 @@ When creating an HTTP response header modification rule via API, make sure you:
 <Render
 	file="rules-creation-workflow"
 	params={{
-		one: "an HTTP response header modification rule",
-		two: "http_response_headers_transform",
+		ruleName: "an HTTP response header modification rule",
+		phaseName: "http_response_headers_transform",
 	}}
 />
 
diff --git a/src/content/docs/rules/transform/url-rewrite/create-api.mdx b/src/content/docs/rules/transform/url-rewrite/create-api.mdx
@@ -24,7 +24,10 @@ When creating a rewrite URL rule via API, make sure you:
 
 <Render
 	file="rules-creation-workflow"
-	params={{ one: "a rewrite URL rule", two: "http_request_transform" }}
+	params={{
+		ruleName: "a rewrite URL rule",
+		phaseName: "http_request_transform",
+	}}
 />
 
 Make sure your API token has the [required permissions](#required-api-token-permissions) to perform the API operations.
diff --git a/src/content/partials/rules/rules-creation-workflow.mdx b/src/content/partials/rules/rules-creation-workflow.mdx
@@ -1,17 +1,18 @@
 ---
-inputParameters: ruleName;;phaseName
-
+params:
+  - ruleName
+  - phaseName
 ---
 
-import { Markdown } from "~/components"
+import { Markdown } from "~/components";
 
-Follow this workflow to create {props.one} for a given zone via API:
+Follow this workflow to create {props.ruleName} for a given zone via API:
 
-1. Use the [List zone rulesets](/api/resources/rulesets/methods/list/) operation to check if there is already a ruleset for the <code>{props.two}</code> phase at the zone level.
+1. Use the [List zone rulesets](/api/resources/rulesets/methods/list/) operation to check if there is already a ruleset for the <code>{props.phaseName}</code> phase at the zone level.
 
 2. If the phase ruleset does not exist, create it using the [Create a zone ruleset](/api/resources/rulesets/methods/create/) operation. In the new ruleset properties, set the following values:
 
-   * **kind**: `zone`
-   * **phase**: <code>{props.two}</code>
+   - **kind**: `zone`
+   - **phase**: <code>{props.phaseName}</code>
 
-3. Use the [Update a zone ruleset](/api/resources/rulesets/methods/update/) operation to add {props.one} to the list of ruleset rules. Alternatively, include the rule in the [Create a zone ruleset](/api/resources/rulesets/methods/create/) request mentioned in the previous step.
+3. Use the [Update a zone ruleset](/api/resources/rulesets/methods/update/) operation to add {props.ruleName} to the list of ruleset rules. Alternatively, include the rule in the [Create a zone ruleset](/api/resources/rulesets/methods/create/) request mentioned in the previous step.
