Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WAF] Use APIRequest component in API examples #21216

Draft
wants to merge 7 commits into
base: production
Choose a base branch
from

Conversation

pedrosousa
Copy link
Contributor

Summary

Partially addresses PCX-16352.

Copy link
Contributor

hyperlint-ai bot commented Mar 28, 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 API documentation to utilize the APIRequest component for improved consistency and clarity.

  • Replaced cURL examples with APIRequest components in multiple API documentation pages.
  • Enhanced the clarity of API examples by standardizing the format across various sections.
  • Removed deprecated cURL syntax in favor of a more structured APIRequest format.

Modified Files

  • src/content/docs/waf/account/custom-rulesets/create-api.mdx
  • src/content/docs/waf/account/managed-rulesets/index.mdx
  • src/content/docs/waf/account/rate-limiting-rulesets/create-api.mdx
  • src/content/docs/waf/custom-rules/create-api.mdx
  • src/content/docs/waf/custom-rules/skip/api-examples.mdx
  • src/content/docs/waf/detections/leaked-credentials/api-calls.mdx
  • src/content/docs/waf/detections/leaked-credentials/get-started.mdx
  • src/content/docs/waf/detections/malicious-uploads/api-calls.mdx
  • src/content/docs/waf/detections/malicious-uploads/get-started.mdx
  • src/content/docs/waf/managed-rules/check-for-exposed-credentials/configure-api.mdx
  • src/content/docs/waf/managed-rules/payload-logging/configure-api.mdx
  • src/content/docs/waf/managed-rules/reference/exposed-credentials-check.mdx
  • src/content/docs/waf/managed-rules/reference/owasp-core-ruleset/configure-api.mdx
  • src/content/docs/waf/managed-rules/reference/sensitive-data-detection.mdx
  • src/content/docs/waf/managed-rules/waf-exceptions/define-api.mdx
  • src/content/docs/waf/rate-limiting-rules/create-api.mdx
  • src/content/docs/waf/tools/user-agent-blocking.mdx
  • src/content/docs/waf/tools/zone-lockdown.mdx
  • src/content/partials/waf/leaked-credentials-detection-enable.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.

Copy link
Contributor

Preview URL: https://2a743a53.preview.developers.cloudflare.com
Preview Branch URL: https://pedro-pcx-16352-waf-use-apirequest-component.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/waf/rate-limiting-rules/create-api/ https://pedro-pcx-16352-waf-use-apirequest-component.preview.developers.cloudflare.com/waf/rate-limiting-rules/create-api/
https://developers.cloudflare.com/waf/managed-rules/reference/owasp-core-ruleset/configure-api/ https://pedro-pcx-16352-waf-use-apirequest-component.preview.developers.cloudflare.com/waf/managed-rules/reference/owasp-core-ruleset/configure-api/
https://developers.cloudflare.com/waf/managed-rules/waf-exceptions/define-api/ https://pedro-pcx-16352-waf-use-apirequest-component.preview.developers.cloudflare.com/waf/managed-rules/waf-exceptions/define-api/
https://developers.cloudflare.com/waf/account/rate-limiting-rulesets/create-api/ https://pedro-pcx-16352-waf-use-apirequest-component.preview.developers.cloudflare.com/waf/account/rate-limiting-rulesets/create-api/
https://developers.cloudflare.com/waf/custom-rules/skip/api-examples/ https://pedro-pcx-16352-waf-use-apirequest-component.preview.developers.cloudflare.com/waf/custom-rules/skip/api-examples/
https://developers.cloudflare.com/waf/account/custom-rulesets/create-api/ https://pedro-pcx-16352-waf-use-apirequest-component.preview.developers.cloudflare.com/waf/account/custom-rulesets/create-api/
https://developers.cloudflare.com/waf/managed-rules/check-for-exposed-credentials/configure-api/ https://pedro-pcx-16352-waf-use-apirequest-component.preview.developers.cloudflare.com/waf/managed-rules/check-for-exposed-credentials/configure-api/
https://developers.cloudflare.com/waf/account/managed-rulesets/ https://pedro-pcx-16352-waf-use-apirequest-component.preview.developers.cloudflare.com/waf/account/managed-rulesets/
https://developers.cloudflare.com/waf/managed-rules/reference/exposed-credentials-check/ https://pedro-pcx-16352-waf-use-apirequest-component.preview.developers.cloudflare.com/waf/managed-rules/reference/exposed-credentials-check/
https://developers.cloudflare.com/waf/managed-rules/payload-logging/configure-api/ https://pedro-pcx-16352-waf-use-apirequest-component.preview.developers.cloudflare.com/waf/managed-rules/payload-logging/configure-api/
https://developers.cloudflare.com/waf/managed-rules/reference/sensitive-data-detection/ https://pedro-pcx-16352-waf-use-apirequest-component.preview.developers.cloudflare.com/waf/managed-rules/reference/sensitive-data-detection/
https://developers.cloudflare.com/waf/detections/leaked-credentials/api-calls/ https://pedro-pcx-16352-waf-use-apirequest-component.preview.developers.cloudflare.com/waf/detections/leaked-credentials/api-calls/
https://developers.cloudflare.com/waf/custom-rules/create-api/ https://pedro-pcx-16352-waf-use-apirequest-component.preview.developers.cloudflare.com/waf/custom-rules/create-api/
https://developers.cloudflare.com/waf/tools/zone-lockdown/ https://pedro-pcx-16352-waf-use-apirequest-component.preview.developers.cloudflare.com/waf/tools/zone-lockdown/
https://developers.cloudflare.com/waf/detections/malicious-uploads/api-calls/ https://pedro-pcx-16352-waf-use-apirequest-component.preview.developers.cloudflare.com/waf/detections/malicious-uploads/api-calls/

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.

4 participants