From: Hannes Laimer <h.laimer@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [pve-devel] [PATCH pve-firewall] cluster: add description to fields returned by refs endpoint
Date: Fri, 28 Nov 2025 15:19:27 +0100 [thread overview]
Message-ID: <20251128141927.274885-1-h.laimer@proxmox.com> (raw)
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
reply other threads:[~2025-11-28 14:19 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20251128141927.274885-1-h.laimer@proxmox.com \
--to=h.laimer@proxmox.com \
--cc=pve-devel@lists.proxmox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox