all lists on lists.proxmox.com
 help / color / mirror / Atom feed
* [pve-devel] [PATCH pve-firewall] cluster: add description to fields returned by refs endpoint
@ 2025-11-28 14:19 Hannes Laimer
  2026-01-14 14:17 ` [pve-devel] applied: " Fiona Ebner
  0 siblings, 1 reply; 2+ messages in thread
From: Hannes Laimer @ 2025-11-28 14:19 UTC (permalink / raw)
  To: pve-devel

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


^ permalink raw reply	[flat|nested] 2+ messages in thread

* [pve-devel] applied: [PATCH pve-firewall] cluster: add description to fields returned by refs endpoint
  2025-11-28 14:19 [pve-devel] [PATCH pve-firewall] cluster: add description to fields returned by refs endpoint Hannes Laimer
@ 2026-01-14 14:17 ` Fiona Ebner
  0 siblings, 0 replies; 2+ messages in thread
From: Fiona Ebner @ 2026-01-14 14:17 UTC (permalink / raw)
  To: pve-devel, Hannes Laimer

Applied, thanks!

[1/1] cluster: add description to fields returned by refs endpoint
      commit: 85a198fd29e89b89f2071b9ce06f34ec77a03b88


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


^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2026-01-14 14:17 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2025-11-28 14:19 [pve-devel] [PATCH pve-firewall] cluster: add description to fields returned by refs endpoint Hannes Laimer
2026-01-14 14:17 ` [pve-devel] applied: " Fiona Ebner

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal