Repository navigation
docs: explain DNS mutation output and record set behavior - #127
Conversation
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configuration
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
adjarteyo-zs
left a comment
There was a problem hiding this comment.
Approved. The DNS CLI documentation matches issue #577’s acceptance criteria.
ClintonChe
left a comment
There was a problem hiding this comment.
The documentation accurately covers the default record-only output, --show-zone, JSON/YAML fields, deletion output, and unchanged dns show behavior. Links and examples were verified, and all PR checks pass. Approved. Please coordinate publication with the CLI fix in zsoftly/zcp-cli#85.
Signed-off-by: godsonten <tendongze.g@zsoftly.com>
4bbb539
Signed-off-by: godsonten <tendongze.g@zsoftly.com>
Signed-off-by: godsonten <tendongze.g@zsoftly.com>
ClintonChe
left a comment
There was a problem hiding this comment.
Re-reviewed the updated documentation at the current head. The create output, --show-zone, CAA support, multi-value record behavior, and labeled pre-delete snapshot documentation now match zcp-cli#85 and the revised ticket contract. Internal links and all required checks pass. No blocking findings. Approved.
What changed
zcpCLI release:dns record-createreturns the value it created anddns record-deletereturns a snapshot of values read from the selected record set beforedeletion.
--show-zonefor either mutation when callers need the resulting full zone, andkeeps
dns showas the full-zone read command.CAAas a supported CLI record type and explains that record creation is additive while arecord-set deletion removes every value at the selected name and type.
file and does not prune values absent from the file.
Why
Implements the documentation portion of https://github.com/zsoftly/iaas/issues/786 alongside
zsoftly/zcp-cli#85.
The implementation uses a pre-deletion snapshot contract. For default deletion, when the CLI prints
a nonempty snapshot, it warns on standard error that concurrent changes can make the snapshot
differ from the values removed.
--show-zoneprints the resulting zone without the snapshotwarning. For default deletion, JSON and YAML keep the record list on standard output without
warning text. Each snapshot row includes
source: pre_delete_snapshot; table rows showPre-delete snapshotin theSOURCEcolumn. This identifies snapshot values when stderr is captured separately. Create and full-zone output have no snapshot source field. With--show-zone, they return the resulting full zone. For default deletion, if a successful delete hasno snapshot, the command returns an empty result and warns. An explicit fully qualified name ending
in a dot permits deletion after an unavailable transient pre-read; relative names and
@requirethe zone lookup, and name-and-type authentication or authorization failures stop the command.
Validation
Changed-page formatting, lint, type checking, and reported-link tests passed locally. The local build reports 66 broken-link targets identical to the saved baseline; the preceding PR head passed the remote build. The new commit must pass CI before merge.