summaryrefslogtreecommitdiff
path: root/docs/automation/vyos-api.md
diff options
context:
space:
mode:
authorJohn Estabrook <jestabro@vyos.io>2026-08-03 08:21:55 -0500
committerMergify <37929162+mergify[bot]@users.noreply.github.com>2026-08-03 13:44:11 +0000
commit5684fcd7b0c1ed5e2fe9fef287faea9efc785722 (patch)
treee475ebd0deb92d0210ff9c30585d030e6c3431b1 /docs/automation/vyos-api.md
parentab1fa1ec1699c1636f44ed52e05b37646c707887 (diff)
downloadvyos-documentation-mergify/bp/circinus/pr-2178.tar.gz
vyos-documentation-mergify/bp/circinus/pr-2178.zip
vyos-api: clarify comment regarding commit failure and partial commits (#2178)mergify/bp/circinus/pr-2178
(cherry picked from commit 4631db6a1578550dd4c1410a8416575899f36936)
Diffstat (limited to 'docs/automation/vyos-api.md')
-rw-r--r--docs/automation/vyos-api.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/automation/vyos-api.md b/docs/automation/vyos-api.md
index 627a7901..224107f5 100644
--- a/docs/automation/vyos-api.md
+++ b/docs/automation/vyos-api.md
@@ -517,10 +517,10 @@ response:
```
A list of operations is applied and committed as a single transaction: if
-any operation fails, nothing is committed. The error message may not
-identify which operation in the list failed, so if a large list fails
-validation, retry the operations in smaller lists (or one per request) to
-locate the offending one.
+any operation fails, nothing is committed *for that component*; partial
+commits are possible for a list of operations comprising more than one
+component. The error message will indicate the component and the missing
+information or conflict.
:::{note}
The `/configure` endpoint commits changes to the running configuration but