vyos-documentation.git/docs/automation, branch mergify/bp/circinus/pr-2178

vyos-api: clarify comment regarding commit failure and partial commits (#2178)

2026-08-03T13:44:11+00:00

(cherry picked from commit 4631db6a1578550dd4c1410a8416575899f36936)

vyos-api: T9087: T9092: apply review feedback (line length, retry safety)

2026-07-21T13:09:02+00:00

Convert the multi-field-node table to wrapped list items per the 80-char docs guideline, and rework the bulk-apply bullet to reconcile state before retrying after a timeout instead of recommending blind retries. Co-Authored-By: Claude Fable 5 (cherry picked from commit 2510eefadc8e7520e7f85f45a2b29fdab634474a)

vyos-api: T9087: tighten firewall same-request wording (review feedback)

2026-07-21T13:09:02+00:00

Only port/port-group require protocol in the same request; description alone is fine on an existing rule but fails on a rule no request has created yet. Co-Authored-By: Claude Fable 5 (cherry picked from commit 9e90088827c53f8d61e82e2e29910a9346009e87)

vyos-api: T9092: add bulk configuration guidance

2026-07-21T13:09:02+00:00

Batch sizing, geoip/remote-group commit cost, the 1 MB request-body-size-limit, and commit-confirm as a remote safety net. Co-Authored-By: Claude Fable 5 (cherry picked from commit af04731c74b0383bc36c66addd6cc22ba41c55e0)

vyos-api: T9090: T9091: batched /configure semantics; save via /config-file

2026-07-21T13:09:01+00:00

Document that an operation list commits as one transaction whose error may not identify the failing op (bisect / one-op fallback), and that /configure rejects {"op": "save"} — persistence goes through /config-file. Co-Authored-By: Claude Fable 5 (cherry picked from commit f002549a5fe3ae782be8fe02160fa2796e7e0471)

vyos-api: T9089: document /retrieve showConfig on empty paths

2026-07-21T13:09:01+00:00

showConfig returns HTTP 400 'Configuration under specified path is empty' for schema-valid but unconfigured paths; recommend probing with exists or treating that error as an empty subtree. Co-Authored-By: Claude Fable 5 (cherry picked from commit 3a952350bf5b5b38a7db1208ed3c910ded7b4b24)

vyos-api: T9088: document /show configuration commands export

2026-07-21T13:09:01+00:00

The /show endpoint can return the running config as flat set commands (op-mode 'show configuration commands' equivalent) — the natural way to mirror or back up a router over the API; previously undocumented. Co-Authored-By: Claude Fable 5 (cherry picked from commit ca902d4eebd49697f476d538eadfcaeb8ebb2232)

vyos-api: T9087: document commit atomicity for multi-field nodes

2026-07-21T13:09:01+00:00

Each /configure request is validated and committed on its own, so fields of one node (task-scheduler executable+interval, NAT translation, firewall action/protocol before port) must be sent in a single request. Co-Authored-By: Claude Fable 5 (cherry picked from commit 0b88b491d043e5f281d8e3ae499c4d045da28f28)

docs(terraform): wrap long install URL in vyoslinter suppression

2026-05-13T23:14:53+00:00

The full HashiCorp install-CLI URL is 79 chars, so any reference definition `[X]: ` form exceeds the 80-char docs-lint limit regardless of label length. Existing `% stop_vyoslinter` / `% start_vyoslinter` markers in this file were back-to-back with no content between them (flagged by Copilot on [vyos-documentation#2021](https://github.com/vyos/vyos-documentation/pull/2021)) — put them to work by wrapping the long `[install Terraform]:` reference. The shorter `[Terraform introduction]:` reference (73 chars) sits outside the suppression range. Both Copilot and CodeRabbit flagged the docs-lint regression on [vyos-documentation#2024](https://github.com/vyos/vyos-documentation/pull/2024) — verified locally with `python3 scripts/doc-linter.py docs/automation/terraform/terraformvyos.md`: no warnings. 🤖 Generated by [robots](https://vyos.io)

docs(terraform): replace non-descriptive [link]/[install] reference labels

2026-05-13T23:14:32+00:00

Surfaced by CodeRabbit on the circinus RST→MD conversion PR [vyos-documentation#2021](https://github.com/vyos/vyos-documentation/pull/2021) (`terraformvyos.md:14`). Both labels violate MD059 (descriptive link text) — generic words like "link" don't convey the destination to screen-reader users or search indexers. Pre-existing on rolling; out of scope for the conversion port, fixed here at the source. Mergify will backport to circinus and sagitta. Sibling `automation/terraform/index.md` already uses the descriptive form ([Terraform], [Ansible]). 🤖 Generated by [robots](https://vyos.io)