Skip to content

Conversation

@marciocloudflare
Copy link
Contributor

@marciocloudflare marciocloudflare commented Mar 11, 2025

Summary

  • 1st iteration of PCX-15975

Documentation checklist

@hyperlint-ai
Copy link
Contributor

hyperlint-ai bot commented Mar 11, 2025

PR Change Summary

Updated API paths and integrated APIRequest component for better API interaction in documentation.

  • Modified API paths for Magic Network Monitoring and Magic Tunnel health alerts.
  • Replaced cURL examples with APIRequest components for improved clarity.
  • Ensured consistency in API documentation across multiple files.

Modified Files

  • src/content/docs/magic-network-monitoring/tutorials/encrypt-network-flow-data.mdx
  • src/content/docs/magic-transit/how-to/configure-magic-tunnel-alerts.mdx
  • src/content/docs/magic-wan/configuration/common-settings/configure-magic-tunnel-alerts.mdx
  • src/content/docs/magic-wan/configuration/connector/network-options/network-segmentation.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.

What is Hyperlint?

Hyperlint is an AI agent that helps you write, edit, and maintain your documentation.

Learn more about the Hyperlint AI reviewer and the checks that we can run on your documentation.

@github-actions
Copy link
Contributor

Howdy and thanks for contributing to our repo. 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.

@marciocloudflare marciocloudflare marked this pull request as ready for review March 11, 2025 09:55
@marciocloudflare marciocloudflare enabled auto-merge (squash) March 11, 2025 10:03
@marciocloudflare marciocloudflare merged commit 2fd36e1 into production Mar 11, 2025
11 checks passed
@marciocloudflare marciocloudflare deleted the marcio/pcx15975-magic-api branch March 11, 2025 10:04
RebeccaTamachiro pushed a commit that referenced this pull request Apr 21, 2025
* added apirequest

* added apirequest comp

* Merge remote-tracking branch 'origin/production' into marcio/pcx15975-magic-api

* removed api

* added apirequest component

* corrected fields

* removed old api example

* added api component
removed old

* corrected link to API site
added apirequest component

* added apirequest import

* added json fields

* corrected json

* removed old example

* corrected output example

* updated api url

* added put apirequest schema

* removed old code

* added response example

* corrected link

* added component corrected enpoint

* deleted old api

* indentation
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