diff options
| author | Brad Kollmyer <bradk@vitalsoft.com> | 2026-07-14 14:00:18 -0700 |
|---|---|---|
| committer | Brad Kollmyer <bradk@vitalsoft.com> | 2026-07-14 14:00:18 -0700 |
| commit | 9e90088827c53f8d61e82e2e29910a9346009e87 (patch) | |
| tree | 74130bbd5f5efa731e817adad2064a42af324a24 /docs | |
| parent | af04731c74b0383bc36c66addd6cc22ba41c55e0 (diff) | |
| download | vyos-documentation-9e90088827c53f8d61e82e2e29910a9346009e87.tar.gz vyos-documentation-9e90088827c53f8d61e82e2e29910a9346009e87.zip | |
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 <noreply@anthropic.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/automation/vyos-api.md | 6 |
1 files changed, 4 insertions, 2 deletions
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 <name>` | `executable` together with `interval` (or `crontab-spec`) | | `nat destination rule <N>` | `translation` together with the other rule fields | -| `firewall ... rule <N>` | `action` and `protocol` together with `description`, `port`, or `port-group` | +| `firewall ... rule <N>` | `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. |