docs(admin-cli): clarify expected interface JSON fields

[chet]

Explain the numeric network_segment_type values accepted by the Expected Machine CLI and make patch omission behavior explicit.

This keeps the live --help output as the source for the generated CLI reference.

Related issues

• Clarify Expected Interface Segment Guard Updates #4847
• Documentation companion: Document Expected Interface IP Allocation Policies #4151

Type of Change

• Add - New feature or capability
• Change - Changes in existing functionality
• Fix - Bug fixes
• Remove - Removed features or deprecated functionality
• Internal - Internal changes (refactoring, tests, docs, etc.)

Breaking Changes

• This PR contains breaking changes

Testing

• Unit tests added/updated
• Integration tests added/updated
• Manual testing performed
• No testing required (docs, internal refactor, etc.)

Additional Notes

Verified the updated contract in nico-admin-cli expected-machine add --help and nico-admin-cli expected-machine patch --help. The generated CLI reference remains isolated in the docs-only #4418 PR.

[chet]

@coderabbitai full_review, thanks!

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 3a414a8c-7aa2-4f9e-a0d5-56feaa1b8e80

📥 Commits

Reviewing files that changed from the base of the PR and between 0c927ed and e158cac.

📒 Files selected for processing (2)

• crates/admin-cli/src/expected_machines/add/args.rs
• crates/admin-cli/src/expected_machines/patch/args.rs

---

Summary by CodeRabbit

• Documentation
  • Clarified the --interfaces command-line option help text.
  • Documented that omitting optional interface fields clears their stored values, including the network segment type.

Walkthrough

The PR updates Expected Machine CLI help text. The patch command now documents that omitted optional interface fields, including network_segment_type, are cleared. The add command help text remains unchanged.

Changes

Expected Machine CLI

Layer / File(s)	Summary
Clarify interface field omission behavior crates/admin-cli/src/expected_machines/add/args.rs, crates/admin-cli/src/expected_machines/patch/args.rs	The patch command documents clearing omitted optional interface fields, including network_segment_type. Existing role and IP-allocation rules remain documented. The add command text is unchanged.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related issues

• Clarify Expected Interface Segment Guard Updates #4847 — Both changes clarify Expected Machine CLI --interfaces help text and omission behavior for network_segment_type.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly identifies the administrative CLI documentation change for expected interface JSON fields.
Description check	✅ Passed	The description accurately covers the numeric network_segment_type values and patch omission behavior described by the changeset.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

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

[coderabbitai]

@chet I will perform a complete review of this pull request.

🐇

✅ Action performed

Full review finished.

[pbreton]

LGTM.