diff options
| author | mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> | 2026-08-04 10:44:24 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2026-08-04 10:44:24 +0100 |
| commit | f13db9802c284166a5ff02dfcd5679034b368d89 (patch) | |
| tree | c68d41fc6b1ec12f7d2d877665e02d8336cf5e35 | |
| parent | 4bb6af6601b35032710dcb03a6941aa95804d116 (diff) | |
| download | vyos-documentation-f13db9802c284166a5ff02dfcd5679034b368d89.tar.gz vyos-documentation-f13db9802c284166a5ff02dfcd5679034b368d89.zip | |
vyos-api: clarify comment regarding commit failure and partial commits (#2178) (#2180)
(cherry picked from commit 4631db6a1578550dd4c1410a8416575899f36936)
Co-authored-by: John Estabrook <jestabro@vyos.io>
| -rw-r--r-- | docs/automation/vyos-api.md | 8 |
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 |