vyos-documentation.git/docs/automation/vyos-api.md, branch scutum

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

2026-08-04T09:44:24+00:00

(cherry picked from commit 4631db6a1578550dd4c1410a8416575899f36936) Co-authored-by: John Estabrook

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)

feat: flip swap mechanism on circinus — MD as primary, RST as override

2026-05-06T18:08:17+00:00

Mirror of #1899 for circinus. Same logic, same scripts, per-branch file set. Changes: - Rename docs/**/md-.md to docs/**/.md (drop md- prefix) for all 253 stems previously listed in docs/_swap.txt - Rename docs/**/.rst to docs/**/rst-.rst (add rst- prefix) for the same 253 stems - Repurpose docs/_swap.txt as docs/_rst_overrides.txt; initially empty - conf.py exclude_patterns flipped: rst-*.rst excluded by default - conf.py runtime-artifact references updated to _rst_override_state.json and _md_exclude.txt - scripts/swap_sources.py rewritten with inverted rename direction (rst-.rst → .rst when applying overrides; .md excluded via _md_exclude.txt) - scripts/import_myst.py and tests/test_import_myst.py deleted (obsolete) - tests/test_swap_sources.py rewritten for new semantics Identical change set to #1899 (current). Per-branch differences: - circinus has 253 stems vs current's 254 (suricata is current-only) - otherwise the script/conf.py/test changes are byte-identical with current Generated by robots https://vyos.io