[pve-devel] [PATCH pve-firewall] cluster: add description to fields returned by refs endpoint

[pve-devel] [PATCH pve-firewall] cluster: add description to fields returned by refs endpoint

[Hannes Laimer]

Signed-off-by: Hannes Laimer <h.laimer@proxmox.com>
---
would also make sense on its own, sending this now because we need
descriptions on the fields for the type generation in pve-api-types

 src/PVE/API2/Firewall/Cluster.pm | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/PVE/API2/Firewall/Cluster.pm b/src/PVE/API2/Firewall/Cluster.pm
index 51d0e43..ebd955d 100644
--- a/src/PVE/API2/Firewall/Cluster.pm
+++ b/src/PVE/API2/Firewall/Cluster.pm
@@ -240,19 +240,24 @@ __PACKAGE__->register_method({
                 type => {
                     type => 'string',
                     enum => ['alias', 'ipset'],
+                    description => "The type of reference (alias or ipset).",
                 },
                 name => {
                     type => 'string',
+                    description => "The name of the alias or ipset.",
                 },
                 ref => {
                     type => 'string',
+                    description => "The reference string used in firewall rules.",
                 },
                 scope => {
                     type => 'string',
+                    description => "The scope of the reference (e.g., SDN).",
                 },
                 comment => {
                     type => 'string',
                     optional => 1,
+                    description => "Optional comment or description.",
                 },
             },
         },
-- 
2.47.3



_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel