Skip to content

Conversation

@pedrosousa
Copy link
Contributor

Summary

Partially addresses PCX-16352.

@pedrosousa pedrosousa requested a review from a team as a code owner March 31, 2025 11:03
@hyperlint-ai
Copy link
Contributor

hyperlint-ai bot commented Mar 31, 2025

Howdy and thanks for contributing to our repo. The Cloudflare team reviews new, external PRs within two (2) weeks. If it's been two weeks or longer without any movement, please tag the PR Assignees in a comment.

We review internal PRs within 1 week. If it's something urgent or has been sitting without a comment, start a thread in the Developer Docs space internally.


PR Change Summary

Updated the documentation to utilize the APIRequest component for various API interactions related to rulesets, enhancing consistency and clarity.

  • Replaced cURL examples with APIRequest components for better readability and consistency.
  • Updated several examples to use dynamic parameters instead of static placeholders.
  • Improved descriptions and context for API interactions in the ruleset documentation.

Modified Files

  • src/content/docs/ruleset-engine/basic-operations/add-rule-phase-rulesets.mdx
  • src/content/docs/ruleset-engine/basic-operations/deploy-rulesets.mdx
  • src/content/docs/ruleset-engine/basic-operations/view-rulesets.mdx
  • src/content/docs/ruleset-engine/custom-rulesets/add-rules-ruleset.mdx
  • src/content/docs/ruleset-engine/custom-rulesets/create-custom-ruleset.mdx
  • src/content/docs/ruleset-engine/custom-rulesets/deploy-custom-ruleset.mdx
  • src/content/docs/ruleset-engine/managed-rulesets/override-examples/deploy-cmr-joomla-only.mdx
  • src/content/docs/ruleset-engine/managed-rulesets/override-examples/deploy-cmr-wordpress-block.mdx
  • src/content/docs/ruleset-engine/managed-rulesets/override-examples/enable-selected-rules.mdx
  • src/content/docs/ruleset-engine/managed-rulesets/override-examples/override-ddos-rule-sensitivity.mdx
  • src/content/docs/ruleset-engine/managed-rulesets/override-examples/override-ruleset-tag-rule.mdx
  • src/content/docs/ruleset-engine/managed-rulesets/override-managed-ruleset.mdx
  • src/content/docs/ruleset-engine/rulesets-api/add-rule.mdx
  • src/content/docs/ruleset-engine/rulesets-api/create.mdx
  • src/content/docs/ruleset-engine/rulesets-api/delete-rule.mdx
  • src/content/docs/ruleset-engine/rulesets-api/delete.mdx
  • src/content/docs/ruleset-engine/rulesets-api/update-rule.mdx
  • src/content/docs/ruleset-engine/rulesets-api/update.mdx
  • src/content/docs/ruleset-engine/rulesets-api/view.mdx

How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

"version": "1",
"action": "log",
"expression": "cf.zone.name eq \"example.com\"",
"last_updated": "2021-03-17T15:42:37.917815Z"
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This example output was incorrect (there was repeated content).

"description": "Executes a managed ruleset.",
"kind": "zone",
"version": "3",
"version": "<RULESET_VERSION>",
Copy link
Contributor Author

@pedrosousa pedrosousa Mar 31, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated: Value depends on what was requested.

"description": "Managed ruleset created by Cloudflare",
"kind": "managed",
"version": "4",
"version": "2",
Copy link
Contributor Author

@pedrosousa pedrosousa Mar 31, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed: Should match the requested ruleset version.

@github-actions
Copy link
Contributor

github-actions bot commented Mar 31, 2025

Preview URL: https://1d225612.preview.developers.cloudflare.com
Preview Branch URL: https://pedro-pcx-16352-ruleset-engine-use-apirequest-component.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/ruleset-engine/managed-rulesets/override-examples/deploy-cmr-joomla-only/ https://pedro-pcx-16352-ruleset-engine-use-apirequest-component.preview.developers.cloudflare.com/ruleset-engine/managed-rulesets/override-examples/deploy-cmr-joomla-only/
https://developers.cloudflare.com/ruleset-engine/managed-rulesets/override-examples/override-ruleset-tag-rule/ https://pedro-pcx-16352-ruleset-engine-use-apirequest-component.preview.developers.cloudflare.com/ruleset-engine/managed-rulesets/override-examples/override-ruleset-tag-rule/
https://developers.cloudflare.com/ruleset-engine/rulesets-api/create/ https://pedro-pcx-16352-ruleset-engine-use-apirequest-component.preview.developers.cloudflare.com/ruleset-engine/rulesets-api/create/
https://developers.cloudflare.com/ruleset-engine/managed-rulesets/override-examples/enable-selected-rules/ https://pedro-pcx-16352-ruleset-engine-use-apirequest-component.preview.developers.cloudflare.com/ruleset-engine/managed-rulesets/override-examples/enable-selected-rules/
https://developers.cloudflare.com/ruleset-engine/rulesets-api/update/ https://pedro-pcx-16352-ruleset-engine-use-apirequest-component.preview.developers.cloudflare.com/ruleset-engine/rulesets-api/update/
https://developers.cloudflare.com/ruleset-engine/rulesets-api/update-rule/ https://pedro-pcx-16352-ruleset-engine-use-apirequest-component.preview.developers.cloudflare.com/ruleset-engine/rulesets-api/update-rule/
https://developers.cloudflare.com/ruleset-engine/managed-rulesets/override-examples/deploy-cmr-wordpress-block/ https://pedro-pcx-16352-ruleset-engine-use-apirequest-component.preview.developers.cloudflare.com/ruleset-engine/managed-rulesets/override-examples/deploy-cmr-wordpress-block/
https://developers.cloudflare.com/ruleset-engine/managed-rulesets/override-managed-ruleset/ https://pedro-pcx-16352-ruleset-engine-use-apirequest-component.preview.developers.cloudflare.com/ruleset-engine/managed-rulesets/override-managed-ruleset/
https://developers.cloudflare.com/ruleset-engine/custom-rulesets/add-rules-ruleset/ https://pedro-pcx-16352-ruleset-engine-use-apirequest-component.preview.developers.cloudflare.com/ruleset-engine/custom-rulesets/add-rules-ruleset/
https://developers.cloudflare.com/ruleset-engine/basic-operations/add-rule-phase-rulesets/ https://pedro-pcx-16352-ruleset-engine-use-apirequest-component.preview.developers.cloudflare.com/ruleset-engine/basic-operations/add-rule-phase-rulesets/
https://developers.cloudflare.com/ruleset-engine/rulesets-api/view/ https://pedro-pcx-16352-ruleset-engine-use-apirequest-component.preview.developers.cloudflare.com/ruleset-engine/rulesets-api/view/
https://developers.cloudflare.com/ruleset-engine/managed-rulesets/override-examples/override-ddos-rule-sensitivity/ https://pedro-pcx-16352-ruleset-engine-use-apirequest-component.preview.developers.cloudflare.com/ruleset-engine/managed-rulesets/override-examples/override-ddos-rule-sensitivity/
https://developers.cloudflare.com/ruleset-engine/custom-rulesets/deploy-custom-ruleset/ https://pedro-pcx-16352-ruleset-engine-use-apirequest-component.preview.developers.cloudflare.com/ruleset-engine/custom-rulesets/deploy-custom-ruleset/
https://developers.cloudflare.com/ruleset-engine/basic-operations/deploy-rulesets/ https://pedro-pcx-16352-ruleset-engine-use-apirequest-component.preview.developers.cloudflare.com/ruleset-engine/basic-operations/deploy-rulesets/
https://developers.cloudflare.com/ruleset-engine/basic-operations/view-rulesets/ https://pedro-pcx-16352-ruleset-engine-use-apirequest-component.preview.developers.cloudflare.com/ruleset-engine/basic-operations/view-rulesets/

Co-authored-by: Rebecca Tamachiro <[email protected]>
@pedrosousa pedrosousa merged commit 9f30453 into production Apr 1, 2025
11 checks passed
@pedrosousa pedrosousa deleted the pedro/PCX-16352-ruleset-engine-use-apirequest-component branch April 1, 2025 09:53
RebeccaTamachiro added a commit that referenced this pull request Apr 21, 2025
---------

Co-authored-by: Rebecca Tamachiro <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants