api: zones: update schema of endpoints

The possible properties returned by the zone endpoints were only
partly documented. Add all missing properties and improve descriptions
for existing properties.

Extract all duplicate properties into a separate variable, so we
don't have to rewrite the whole API definition for every endpoint.

Signed-off-by: Stefan Hanreich <s.hanreich@proxmox.com>
Reviewed-by: Dominik Csapak <d.csapak@proxmox.com>
Tested-by: Dominik Csapak <d.csapak@proxmox.com>

1 files changed, 9 insertions, 7 deletions

diff --git a/src/PVE/Network/SDN/Zones/VxlanPlugin.pm b/src/PVE/Network/SDN/Zones/VxlanPlugin.pm
index 8f6fba0..1db610f 100644
--- a/src/PVE/Network/SDN/Zones/VxlanPlugin.pm
+++ b/src/PVE/Network/SDN/Zones/VxlanPlugin.pm
@@ -27,20 +27,22 @@ sub type {
 sub properties {
     return {
         'peers' => {
-            description => "peers address list.",
+            description =>
+                "Comma-separated list of peers, that are part of the VXLAN zone. Usually the IPs of the nodes.",
             type => 'string',
             format => 'ip-list',
         },
-        fabric => {
-            description => "SDN fabric to use as underlay for this VXLAN zone.",
-            type => 'string',
-            format => 'pve-sdn-fabric-id',
-        },
         'vxlan-port' => {
-            description => "Vxlan tunnel udp port (default 4789).",
+            description => "UDP port that should be used for the VXLAN tunnel (default 4789).",
             minimum => 1,
             maximum => 65536,
             type => 'integer',
+            default => 4789,
+        },
+        fabric => {
+            description => "SDN fabric to use as underlay for this VXLAN zone.",
+            type => 'string',
+            format => 'pve-sdn-fabric-id',
         },
     };
 }