Skip to content

docs: explain DNS mutation output and record set behavior - #127

Merged
godsonten merged 4 commits into
mainfrom
issues/577-dns-record-output
Oct 20, 2026
Merged

godsonten merged 4 commits into
mainfrom
issues/577-dns-record-output

Conversation

@godsonten

@godsonten godsonten commented Oct 16, 2026 •

Copy link
Copy Markdown
Collaborator

What changed

  • Documents the next zcp CLI release: dns record-create returns the value it created and
    dns record-delete returns a snapshot of values read from the selected record set before
    deletion.
  • Documents --show-zone for either mutation when callers need the resulting full zone, and
    keeps dns show as the full-zone read command.
  • Lists CAA as a supported CLI record type and explains that record creation is additive while a
    record-set deletion removes every value at the selected name and type.
  • Clarifies the version-controlled-zone tutorial: its apply script adds the records named in the
    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-zone prints the resulting zone without the snapshot
warning. 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 show Pre-delete snapshot in the SOURCE column. 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 has
no 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 @ require
the 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.

@coderabbitai

coderabbitai Bot commented Oct 16, 2026 •

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 282ca68f-e925-486d-b5c6-01a8ef7f4de0
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

adjarteyo-zs
adjarteyo-zs previously approved these changes Oct 19, 2026

@adjarteyo-zs adjarteyo-zs left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Approved. The DNS CLI documentation matches issue #577’s acceptance criteria.

ClintonChe
ClintonChe previously approved these changes Oct 19, 2026

@ClintonChe ClintonChe left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

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>
@godsonten
godsonten dismissed stale reviews from ClintonChe and adjarteyo-zs via 4bbb539 October 19, 2026 19:33
Signed-off-by: godsonten <tendongze.g@zsoftly.com>
Signed-off-by: godsonten <tendongze.g@zsoftly.com>

@ClintonChe ClintonChe left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

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.

@godsonten
godsonten merged commit f04099e into main Oct 20, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants