From: Phil Sutter <phil@nwl.cc>
Date: Thu, 6 Nov 2025 11:14:56 +0000 (+0100)
Subject: doc: libnftables-json: Describe RULESET object
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;ds=sidebyside;p=thirdparty%2Fnftables.git

doc: libnftables-json: Describe RULESET object

Document the syntax of this meta-object used by "list" and "flush"
commands only.

Fixes: 872f373dc50f7 ("doc: Add JSON schema documentation")
Signed-off-by: Phil Sutter <phil@nwl.cc>
---

diff --git a/doc/libnftables-json.adoc b/doc/libnftables-json.adoc
index 643884d5..049c3254 100644
--- a/doc/libnftables-json.adoc
+++ b/doc/libnftables-json.adoc
@@ -200,6 +200,18 @@ Rename a chain. The new name is expected in a dedicated property named
 
 == RULESET ELEMENTS
 
+=== RULESET
+[verse]
+____
+*{ "ruleset":* 'RULSET_PROPERTIES' *}*
+
+'RULESET_PROPERTIES' := *null* | *{ "family":* 'STRING' *}*
+____
+
+This is a special object for use with *list* and *flush* commands which will
+then operate on either the whole ruleset or the parts of it belonging to the
+given family.
+
 === TABLE
 [verse]
 ____