[PATCH pve-network 11/13] api: fabric status: add schema for wireguard properties

[Stefan Hanreich <s.hanreich@proxmox.com>]

The WireGuard fabric returns lots of addtional options in status
reporting, add the properties to the return schema. Additionally,
improve the description of the existing properties, so the format is
more clear.

Signed-off-by: Stefan Hanreich <s.hanreich@proxmox.com>
---
 src/PVE/API2/Network/SDN/Nodes/Fabric.pm | 71 +++++++++++++++++++++++-
 1 file changed, 68 insertions(+), 3 deletions(-)

diff --git a/src/PVE/API2/Network/SDN/Nodes/Fabric.pm b/src/PVE/API2/Network/SDN/Nodes/Fabric.pm
index 0202b81e..28aa2030 100644
--- a/src/PVE/API2/Network/SDN/Nodes/Fabric.pm
+++ b/src/PVE/API2/Network/SDN/Nodes/Fabric.pm
@@ -115,17 +115,71 @@ __PACKAGE__->register_method({
             type => "object",
             properties => {
                 neighbor => {
-                    description => "The IP or hostname of the neighbor.",
+                    description => "The IP or hostname of the neighbor (including the port for WireGuard).",
+                    format_description => '(<IP>|<Host>)[:<port>]',
                     type => 'string',
                 },
                 status => {
-                    description => "The status of the neighbor, as returned by FRR.",
+                    description => "The status of the neighbor, as returned by FRR (OSPF, Openfabric, BGP only)",
                     type => 'string',
+                    optional => 1,
                 },
                 uptime => {
                     description =>
-                        "The uptime of this neighbor, as returned by FRR (e.g. 8h24m12s).",
+                        "The uptime of this neighbor, as returned by FRR, e.g. 8h24m12s (OSPF, Openfabric, BGP only)",
                     type => 'string',
+                    optional => 1,
+                },
+                name => {
+                    description =>
+                        "The name for this neighbor in the WireGuard fabric. (WireGuard only)",
+                    format_description => '(<IP>|<Host>)[ (<interface>)]',
+                    type => 'string',
+                    optional => 1,
+                },
+                interface => {
+                    description =>
+                        "The name of the interface that uses this neighbor as peer (WireGuard only)",
+                    type => 'string',
+                    optional => 1,
+                },
+                'public-key' => {
+                    description =>
+                        "The public key used for this neighbor (WireGuard only)",
+                    format_description => 'Base64-encoded Curve 25519 public key.',
+                    type => 'string',
+                    optional => 1,
+                },
+                'allowed-ips' => {
+                    description =>
+                        "The allowed IPs for this neighbor (WireGuard only)",
+                    type => 'string',
+                    format_description => 'Comma-separated list of CIDRs.',
+                    optional => 1,
+                },
+                'latest-handshake' => {
+                    description =>
+                        "UNIX Timestamp of the last successful handshake (WireGuard only)",
+                    type => 'number',
+                    optional => 1,
+                },
+                'bytes-rx' => {
+                    description =>
+                        "The amount of bytes received from this neighbor (WireGuard only)",
+                    type => 'number',
+                    optional => 1,
+                },
+                'bytes-tx' => {
+                    description =>
+                        "The amount of bytes transmitted to this neighbor (WireGuard only)",
+                    type => 'number',
+                    optional => 1,
+                },
+                'persistent-keepalive' => {
+                    description =>
+                        "The currently used persistent keepalive interval for this neighbor (WireGuard only)",
+                    type => 'number',
+                    optional => 1,
                 },
             },
         },
@@ -173,6 +227,17 @@ __PACKAGE__->register_method({
                     description => "The current state of the interface.",
                     type => 'string',
                 },
+                'public-key' => {
+                    description => "The public key of the interface (WireGuard only).",
+                    format_description => 'Base64-encoded Curve 25519 public key.',
+                    type => 'string',
+                    optional => 1,
+                },
+                'listen-port' => {
+                    description => "The listen port of the interface (WireGuard only).",
+                    type => 'number',
+                    optional => 1,
+                },
             },
         },
     },
-- 
2.47.3