Skip to content

Conversation

@pedrosousa
Copy link
Contributor

Summary

Partially addresses PCX-16352.

@github-actions github-actions bot added the product:rules Related to rules label Mar 28, 2025
@hyperlint-ai
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 various API examples, enhancing consistency and clarity.

  • Replaced cURL examples with APIRequest components in multiple documentation files.
  • Improved the structure of API examples for better readability and consistency.
  • Updated several API examples to include JSON request bodies using the APIRequest format.

Modified Files

  • src/content/docs/rules/cloud-connector/create-api.mdx
  • src/content/docs/rules/compression-rules/examples/disable-all-brotli.mdx
  • src/content/docs/rules/compression-rules/examples/disable-compression-avif.mdx
  • src/content/docs/rules/compression-rules/examples/enable-zstandard.mdx
  • src/content/docs/rules/compression-rules/examples/gzip-for-csv.mdx
  • src/content/docs/rules/compression-rules/examples/only-brotli-url-path.mdx
  • src/content/docs/rules/configuration-rules/create-api.mdx
  • src/content/docs/rules/custom-errors/create-api.mdx
  • src/content/docs/rules/origin-rules/create-api.mdx
  • src/content/docs/rules/snippets/create-api.mdx
  • src/content/docs/rules/transform/managed-transforms/configure.mdx
  • src/content/docs/rules/transform/request-header-modification/create-api.mdx
  • src/content/docs/rules/transform/response-header-modification/create-api.mdx
  • src/content/docs/rules/transform/url-rewrite/create-api.mdx
  • src/content/docs/rules/url-forwarding/bulk-redirects/create-api.mdx
  • src/content/docs/rules/url-forwarding/single-redirects/create-api.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.

@github-actions
Copy link
Contributor

github-actions bot commented Mar 28, 2025

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

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/rules/transform/response-header-modification/create-api/ https://pedro-pcx-16352-rules-use-apirequest-component.preview.developers.cloudflare.com/rules/transform/response-header-modification/create-api/
https://developers.cloudflare.com/rules/url-forwarding/bulk-redirects/create-api/ https://pedro-pcx-16352-rules-use-apirequest-component.preview.developers.cloudflare.com/rules/url-forwarding/bulk-redirects/create-api/
https://developers.cloudflare.com/rules/custom-errors/create-api/ https://pedro-pcx-16352-rules-use-apirequest-component.preview.developers.cloudflare.com/rules/custom-errors/create-api/
https://developers.cloudflare.com/rules/origin-rules/create-api/ https://pedro-pcx-16352-rules-use-apirequest-component.preview.developers.cloudflare.com/rules/origin-rules/create-api/
https://developers.cloudflare.com/rules/transform/request-header-modification/create-api/ https://pedro-pcx-16352-rules-use-apirequest-component.preview.developers.cloudflare.com/rules/transform/request-header-modification/create-api/
https://developers.cloudflare.com/rules/url-forwarding/single-redirects/create-api/ https://pedro-pcx-16352-rules-use-apirequest-component.preview.developers.cloudflare.com/rules/url-forwarding/single-redirects/create-api/
https://developers.cloudflare.com/rules/transform/managed-transforms/configure/ https://pedro-pcx-16352-rules-use-apirequest-component.preview.developers.cloudflare.com/rules/transform/managed-transforms/configure/
https://developers.cloudflare.com/rules/transform/url-rewrite/create-api/ https://pedro-pcx-16352-rules-use-apirequest-component.preview.developers.cloudflare.com/rules/transform/url-rewrite/create-api/
https://developers.cloudflare.com/rules/configuration-rules/create-api/ https://pedro-pcx-16352-rules-use-apirequest-component.preview.developers.cloudflare.com/rules/configuration-rules/create-api/
https://developers.cloudflare.com/rules/snippets/create-api/ https://pedro-pcx-16352-rules-use-apirequest-component.preview.developers.cloudflare.com/rules/snippets/create-api/
https://developers.cloudflare.com/rules/compression-rules/examples/enable-zstandard/ https://pedro-pcx-16352-rules-use-apirequest-component.preview.developers.cloudflare.com/rules/compression-rules/examples/enable-zstandard/
https://developers.cloudflare.com/rules/cloud-connector/create-api/ https://pedro-pcx-16352-rules-use-apirequest-component.preview.developers.cloudflare.com/rules/cloud-connector/create-api/
https://developers.cloudflare.com/rules/compression-rules/examples/disable-compression-avif/ https://pedro-pcx-16352-rules-use-apirequest-component.preview.developers.cloudflare.com/rules/compression-rules/examples/disable-compression-avif/
https://developers.cloudflare.com/rules/compression-rules/examples/gzip-for-csv/ https://pedro-pcx-16352-rules-use-apirequest-component.preview.developers.cloudflare.com/rules/compression-rules/examples/gzip-for-csv/
https://developers.cloudflare.com/rules/compression-rules/examples/disable-all-brotli/ https://pedro-pcx-16352-rules-use-apirequest-component.preview.developers.cloudflare.com/rules/compression-rules/examples/disable-all-brotli/

<APIRequest path="/zones/{zone_id}/managed_headers" method="GET" />

```json
```json output collapse={9-40,48-52}
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated the example output.

/>

```json
```json output collapse={4-13,19-40,48-52}
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated the example output.

@pedrosousa pedrosousa marked this pull request as ready for review April 2, 2025 09:18
@pedrosousa pedrosousa requested a review from a team as a code owner April 2, 2025 09:18
@pedrosousa pedrosousa merged commit e59ec12 into production Apr 2, 2025
11 checks passed
@pedrosousa pedrosousa deleted the pedro/PCX-16352-rules-use-apirequest-component branch April 2, 2025 13:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

product:rules Related to rules size/xl

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants