Skip to content

[Page Shield] Use APIRequest component #21921

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

Merged

Conversation

pedrosousa
Copy link
Contributor

Summary

Partially addresses PCX-16352.

@pedrosousa pedrosousa requested a review from a team as a code owner April 23, 2025 09:34
@github-actions github-actions bot added product:page-shield Issues or PRs related to Page Shield size/m labels Apr 23, 2025
Copy link
Contributor

hyperlint-ai bot commented Apr 23, 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 Page Shield documentation to utilize the APIRequest component for API examples and improved clarity in policy violation reporting.

  • Replaced cURL examples with APIRequest components for better readability.
  • Enhanced clarity in the description of policy violations and their reporting.
  • Updated GraphQL API query examples for consistency and formatting.

Modified Files

  • src/content/docs/page-shield/policies/violations.mdx
  • src/content/docs/page-shield/reference/page-shield-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.

@@ -41,36 +39,43 @@ For an introduction to GraphQL querying, refer to [Querying basics](/analytics/g
### Example

```graphql title="Example GraphQL query"
query PageShieldReports($zoneTag: string, $datetimeStart: string, $datetimeEnd: string) {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

No changes (spaces replaced with tabs).

@pedrosousa pedrosousa merged commit a5590f3 into production Apr 23, 2025
14 checks passed
@pedrosousa pedrosousa deleted the pedro/PCX-16352-pageshield-use-apirequest-component branch April 23, 2025 10:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
product:page-shield Issues or PRs related to Page Shield size/m
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants