[PATCH proxmox-ve-rs 1/1] ve-config: add missing descriptions to section config enums

[PATCH proxmox-ve-rs 1/1] ve-config: add missing descriptions to section config enums

[Stefan Hanreich]

Signed-off-by: Stefan Hanreich <s.hanreich@proxmox.com>
---
 proxmox-ve-config/src/sdn/fabric/section_config/fabric.rs | 4 ++++
 proxmox-ve-config/src/sdn/fabric/section_config/mod.rs    | 8 ++++++++
 proxmox-ve-config/src/sdn/fabric/section_config/node.rs   | 4 ++++
 proxmox-ve-config/src/sdn/route_map.rs                    | 1 +
 4 files changed, 17 insertions(+)

diff --git a/proxmox-ve-config/src/sdn/fabric/section_config/fabric.rs b/proxmox-ve-config/src/sdn/fabric/section_config/fabric.rs
index 9d380c5..f465114 100644
--- a/proxmox-ve-config/src/sdn/fabric/section_config/fabric.rs
+++ b/proxmox-ve-config/src/sdn/fabric/section_config/fabric.rs
@@ -172,10 +172,14 @@ impl UpdaterType for FabricSection<BgpProperties> {
 #[derive(Debug, Clone, Serialize, Deserialize, Hash)]
 #[serde(rename_all = "snake_case", tag = "protocol")]
 pub enum Fabric {
+    /// Section type for OpenFabric fabrics. See [`FabricSection`] and [`OpenfabricProperties`].
     Openfabric(FabricSection<OpenfabricProperties>),
+    /// Section type for OSPF fabrics. See [`FabricSection`] and [`OspfProperties`].
     Ospf(FabricSection<OspfProperties>),
+    /// Section type for WireGuard fabrics. See [`FabricSection`] and [`WireGuardProperties`].
     #[serde(rename = "wireguard")]
     WireGuard(FabricSection<WireGuardProperties>),
+    /// Section type for BGP fabrics. See [`FabricSection`] and [`BgpProperties`].
     Bgp(FabricSection<BgpProperties>),
 }
 
diff --git a/proxmox-ve-config/src/sdn/fabric/section_config/mod.rs b/proxmox-ve-config/src/sdn/fabric/section_config/mod.rs
index 35057c7..7f81823 100644
--- a/proxmox-ve-config/src/sdn/fabric/section_config/mod.rs
+++ b/proxmox-ve-config/src/sdn/fabric/section_config/mod.rs
@@ -67,15 +67,23 @@ pub const SECTION_ID_FORMAT: ApiStringFormat = ApiStringFormat::Pattern(&SECTION
 #[derive(Debug, Clone, Serialize, Deserialize)]
 #[serde(rename_all = "snake_case", tag = "type")]
 pub enum Section {
+    /// Section type for OpenFabric fabrics. See [`FabricSection`] and [`OpenfabricProperties`].
     OpenfabricFabric(FabricSection<OpenfabricProperties>),
+    /// Section type for OSPF fabrics. See [`FabricSection`] and [`OspfProperties`].
     OspfFabric(FabricSection<OspfProperties>),
+    /// Section type for WireGuard fabrics. See [`FabricSection`] and [`WireGuardProperties`].
     #[serde(rename = "wireguard_fabric")]
     WireGuardFabric(FabricSection<WireGuardProperties>),
+    /// Section type for BGP fabrics. See [`FabricSection`] and [`BgpProperties`].
     BgpFabric(FabricSection<BgpProperties>),
+    /// Section type for OpenFabric nodes. See [`NodeSection`] and [`OpenfabricNodeProperties`].
     OpenfabricNode(NodeSection<OpenfabricNodeProperties>),
+    /// Section type for OSPF nodes. See [`NodeSection`] and [`OspfNodeProperties`].
     OspfNode(NodeSection<OspfNodeProperties>),
+    /// Section type for WireGuard nodes. See [`NodeSection`] and [`WireGuardNode`].
     #[serde(rename = "wireguard_node")]
     WireGuardNode(NodeSection<WireGuardNode>),
+    /// Section type for BGP nodes. See [`NodeSection`] and [`BgpNode`].
     BgpNode(NodeSection<BgpNode>),
 }
 
diff --git a/proxmox-ve-config/src/sdn/fabric/section_config/node.rs b/proxmox-ve-config/src/sdn/fabric/section_config/node.rs
index d22a547..1c529de 100644
--- a/proxmox-ve-config/src/sdn/fabric/section_config/node.rs
+++ b/proxmox-ve-config/src/sdn/fabric/section_config/node.rs
@@ -188,10 +188,14 @@ impl<T: ApiType> ApiType for NodeSection<T> {
 #[derive(Debug, Clone, Serialize, Deserialize, Hash)]
 #[serde(rename_all = "snake_case", tag = "protocol")]
 pub enum Node {
+    /// Section type for OpenFabric nodes. See [`NodeSection`] and [`OpenfabricNodeProperties`].
     Openfabric(NodeSection<OpenfabricNodeProperties>),
+    /// Section type for OSPF nodes. See [`NodeSection`] and [`OspfNodeProperties`].
     Ospf(NodeSection<OspfNodeProperties>),
+    /// Section type for WireGuard nodes. See [`NodeSection`] and [`WireGuardNode`].
     #[serde(rename = "wireguard")]
     WireGuard(NodeSection<WireGuardNode>),
+    /// Section type for BGP nodes. See [`NodeSection`] and [`BgpNode`].
     Bgp(NodeSection<BgpNode>),
 }
 
diff --git a/proxmox-ve-config/src/sdn/route_map.rs b/proxmox-ve-config/src/sdn/route_map.rs
index 73eb7bb..3a7a5a4 100644
--- a/proxmox-ve-config/src/sdn/route_map.rs
+++ b/proxmox-ve-config/src/sdn/route_map.rs
@@ -150,6 +150,7 @@ proxmox_serde::forward_deserialize_to_from_str!(RouteMapEntryId);
 #[serde(rename_all = "kebab-case", tag = "type")]
 /// The Route Map section config type.
 pub enum RouteMap {
+    /// Section type for entries in a route map. See [`RouteMapEntry`].
     RouteMapEntry(RouteMapEntry),
 }
 
-- 
2.47.3