Skip to content

[DNS] API docs link review #22853

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
merged 5 commits into from
Jun 4, 2025

Conversation

RebeccaTamachiro
Copy link
Contributor

@RebeccaTamachiro RebeccaTamachiro commented Jun 3, 2025

Summary

PCX-14409
Change from /api/resources/dns/subresources/settings/methods/edit/ to

  • /api/resources/dns/subresources/settings/subresources/zone/methods/edit/ for zone-level
  • /api/resources/dns/subresources/settings/subresources/account/methods/edit/ for account-level

Copy link
Contributor

hyperlint-ai bot commented Jun 3, 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 links for DNS settings to reflect the correct endpoint paths.

  • Corrected the endpoint links for updating DNS settings in multiple documentation files.
  • Ensured consistency in API documentation regarding DNS settings across various sections.

Modified Files

  • src/content/docs/dns/cname-flattening/set-up-cname-flattening.mdx
  • src/content/docs/dns/foundation-dns/setup.mdx
  • src/content/docs/dns/nameservers/custom-nameservers/account-custom-nameservers.mdx
  • src/content/docs/dns/zone-setups/conversions/convert-full-to-secondary.mdx
  • src/content/docs/dns/zone-setups/conversions/convert-partial-to-secondary.mdx
  • src/content/docs/dns/zone-setups/conversions/convert-secondary-to-full.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

github-actions bot commented Jun 3, 2025

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern Owners
/src/content/docs/dns/ @RebeccaTamachiro, @cloudflare/pcx-technical-writing
* @cloudflare/pcx-technical-writing

Copy link
Contributor

github-actions bot commented Jun 3, 2025

Preview URL: https://dffd1979.preview.developers.cloudflare.com
Preview Branch URL: https://rebecca-dns-api-docs-link-review.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/dns/nameservers/custom-nameservers/account-custom-nameservers/ https://rebecca-dns-api-docs-link-review.preview.developers.cloudflare.com/dns/nameservers/custom-nameservers/account-custom-nameservers/
https://developers.cloudflare.com/dns/cname-flattening/set-up-cname-flattening/ https://rebecca-dns-api-docs-link-review.preview.developers.cloudflare.com/dns/cname-flattening/set-up-cname-flattening/
https://developers.cloudflare.com/dns/foundation-dns/setup/ https://rebecca-dns-api-docs-link-review.preview.developers.cloudflare.com/dns/foundation-dns/setup/
https://developers.cloudflare.com/dns/nameservers/custom-nameservers/tenant-custom-nameservers/ https://rebecca-dns-api-docs-link-review.preview.developers.cloudflare.com/dns/nameservers/custom-nameservers/tenant-custom-nameservers/
https://developers.cloudflare.com/dns/zone-setups/conversions/convert-full-to-secondary/ https://rebecca-dns-api-docs-link-review.preview.developers.cloudflare.com/dns/zone-setups/conversions/convert-full-to-secondary/
https://developers.cloudflare.com/dns/zone-setups/conversions/convert-partial-to-secondary/ https://rebecca-dns-api-docs-link-review.preview.developers.cloudflare.com/dns/zone-setups/conversions/convert-partial-to-secondary/
https://developers.cloudflare.com/dns/zone-setups/conversions/convert-secondary-to-full/ https://rebecca-dns-api-docs-link-review.preview.developers.cloudflare.com/dns/zone-setups/conversions/convert-secondary-to-full/

@RebeccaTamachiro RebeccaTamachiro marked this pull request as ready for review June 3, 2025 13:02
@RebeccaTamachiro RebeccaTamachiro requested a review from a team as a code owner June 3, 2025 13:02
windsurf-bot[bot]

This comment was marked as off-topic.

@@ -148,8 +148,8 @@ To remove ACNS from a zone, first update your nameservers to stop using ACNS:
</TabItem>
<TabItem label="API">

* If you are using [Cloudflare Registrar](/registrar/), use the [Update DNS settings endpoint](/api/resources/dns/subresources/settings/methods/edit/) to change the `enabled` parameter to `false`, and then [contact Cloudflare Support](/support/contacting-cloudflare-support/) to set your nameservers back to the regular Cloudflare branded nameservers.
* If you are not using [Cloudflare Registrar](/registrar/), modify the domain's registrar to use your regular Cloudflare branded nameservers and then use the [Update DNS settings endpoint](/api/resources/dns/subresources/settings/methods/edit/) to set the `enabled` parameter to `false`.
* If you are using [Cloudflare Registrar](/registrar/), use the [Update DNS settings endpoint](/api/resources/dns/subresources/settings/subresources/zone/methods/edit/) to change the `enabled` parameter to `false`, and then [contact Cloudflare Support](/support/contacting-cloudflare-support/) to set your nameservers back to the regular Cloudflare branded nameservers.
Copy link
Contributor

Choose a reason for hiding this comment

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

On that endpoint, the user needs to set the type parameter in the nameservers object to "cloudflare.standard" in order to move back to Cloudflare standard nameservers.

@RebeccaTamachiro RebeccaTamachiro merged commit bad6ea6 into production Jun 4, 2025
11 checks passed
@RebeccaTamachiro RebeccaTamachiro deleted the rebecca/dns-api-docs-link-review branch June 4, 2025 14:09
sdnts pushed a commit to sdnts/cloudflare-docs that referenced this pull request Jul 24, 2025
* First pass with find and replace

* Fix deprecations yaml differentiating zone vs account

* Update links to DNS settings for account

* Fix broken link prior to review of disablement flow

* Adjust disable instructions to account for current endpoint
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
product:dns Issues or PRs related to DNS size/s
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants