[DNS] Fix four confirmed doc errors found in code/API audit#28452
Draft
kodster28 wants to merge 1 commit intoproductionfrom
Draft
[DNS] Fix four confirmed doc errors found in code/API audit#28452kodster28 wants to merge 1 commit intoproductionfrom
kodster28 wants to merge 1 commit intoproductionfrom
Conversation
- dns-record-types: fix CNAME response example showing type 'A' instead of 'CNAME' (copy-paste from A record example above) - dns-record-types: add caution that NS records cannot share a name with any other record type (stated in API notes but absent from docs) - ttl: add API representation section clarifying that ttl value 1 means Auto (300s), not a 1-second TTL - dns-quick-scan: add deprecation caution for POST /dns_records/scan, document the three-step async flow, and call out that the new flow does not auto-add records
kodster28
commented
Feb 19, 2026
|
|
||
| These records include the following fields: | ||
|
|
||
| <Render file="records-name-field" product="dns" />- **IPv4/IPv6 address**: Your |
Collaborator
Author
There was a problem hiding this comment.
Interesting hallucination here.
kodster28
commented
Feb 19, 2026
| - If the **Proxy Status** is **Proxied**, this value defaults to **Auto**, which is 300 seconds. | ||
| - If the **Proxy Status** is **DNS Only**, you can customize the value. | ||
| - **Proxy status**: For more details, refer to [Proxied DNS records](/dns/proxy-status/). | ||
| <Render file="records-name-field" product="dns" />- **Target**: The hostname |
Collaborator
Author
There was a problem hiding this comment.
And throughout here too
kodster28
commented
Feb 19, 2026
| Your assigned Cloudflare nameservers, custom nameservers, and their corresponding [nameserver TTLs](/dns/nameservers/nameserver-options/#nameserver-ttl) are controlled via dedicated sections on the [**DNS Records**](https://dash.cloudflare.com/?to=/:account/:zone/dns/records) page. For details, refer to [Nameservers](/dns/nameservers/). | ||
| ::: | ||
|
|
||
| :::caution |
Collaborator
Author
There was a problem hiding this comment.
Don't love a caution after another caution
kodster28
commented
Feb 19, 2026
| "zone_name": "example.com", | ||
| "name": "www.example.com", | ||
| "type": "A", | ||
| "type": "CNAME", |
Collaborator
Author
There was a problem hiding this comment.
Core of this file's changes.
Contributor
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
kodster28
commented
Feb 19, 2026
|
|
||
| ## API representation | ||
|
|
||
| When using the API, TTL values are integers in seconds. The value `1` is a special sentinel that means **Auto** (300 seconds effective TTL) — it does not mean a 1-second TTL. |
Collaborator
Author
There was a problem hiding this comment.
Suggested change
| When using the API, TTL values are integers in seconds. The value `1` is a special sentinel that means **Auto** (300 seconds effective TTL) — it does not mean a 1-second TTL. | |
| When using the API, TTL values are integers in seconds. The value `1` means **Auto** (300 seconds effective TTL) — it does not mean a 1-second TTL. |
kodster28
commented
Feb 19, 2026
|
|
||
| When using the API, TTL values are integers in seconds. The value `1` is a special sentinel that means **Auto** (300 seconds effective TTL) — it does not mean a 1-second TTL. | ||
|
|
||
| You will see `"ttl": 1` in API responses for any record set to Auto. To set Auto when creating or updating a record, send `"ttl": 1`. |
kodster28
commented
Feb 19, 2026
| On the dashboard, quick scan is only available as you are onboarding a new domain. Via API, you can manually invoke quick scan with the [Trigger DNS Records Scan endpoint](/api/resources/dns/subresources/records/methods/scan_trigger/). | ||
| ::: | ||
|
|
||
| :::caution[Deprecated API endpoint] |
Collaborator
Author
There was a problem hiding this comment.
Unclear how this connects to the other scan trigger, b/c we never explicitly mention this one
Contributor
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Seems clear
Needs eval about placement, phrasing, etc.