From 9e90088827c53f8d61e82e2e29910a9346009e87 Mon Sep 17 00:00:00 2001 From: Brad Kollmyer Date: Tue, 14 Jul 2026 14:00:18 -0700 Subject: vyos-api: T9087: tighten firewall same-request wording (review feedback) 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 --- docs/automation/vyos-api.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/automation/vyos-api.md b/docs/automation/vyos-api.md index 1342a124..8007a75b 100644 --- a/docs/automation/vyos-api.md +++ b/docs/automation/vyos-api.md @@ -490,12 +490,14 @@ of operations (see below). Common examples: |------|---------------------------------| | `system task-scheduler task ` | `executable` together with `interval` (or `crontab-spec`) | | `nat destination rule ` | `translation` together with the other rule fields | -| `firewall ... rule ` | `action` and `protocol` together with `description`, `port`, or `port-group` | +| `firewall ... rule ` | `action` in the request that creates the rule; `protocol` together with `port` or `port-group` | Sending such fields in separate requests fails validation with errors such as `Protocol must be defined if specifying a port or port-group` or `must define either interval or crontab-spec`, because each request is -validated as a complete commit on its own. +validated as a complete commit on its own. Likewise, setting an attribute +such as `description` on a rule that no request has created yet fails with +`Configuration path ... is not valid`. The endpoint can process multiple commands if you pass them as a list to the `data` field. -- cgit v1.2.3