From fbe878407c95bc7b6a4621e4e319e69be34a579d Mon Sep 17 00:00:00 2001
From: Ruben Fiszel <ruben@rubenfiszel.com>
Date: Sat, 6 Aug 2022 23:32:17 +0200
Subject: [PATCH] add summary field for modules

---
 backend/src/flows.rs                          | 5 +++++
 frontend/src/lib/components/FlowViewer.svelte | 1 +
 openflow.openapi.yaml                         | 2 ++
 3 files changed, 8 insertions(+)

diff --git a/backend/src/flows.rs b/backend/src/flows.rs
index 05de561abc..094a0fdf69 100644
--- a/backend/src/flows.rs
+++ b/backend/src/flows.rs
@@ -81,6 +81,7 @@ pub struct FlowModule {
     pub value: FlowModuleValue,
     pub stop_after_if_expr: Option<String>,
     pub skip_if_stopped: Option<bool>,
+    pub summary: Option<String>,
 }
 
 #[derive(Deserialize, Serialize, Debug, Clone)]
@@ -422,6 +423,7 @@ mod tests {
                     value: FlowModuleValue::Script { path: "test".to_string() },
                     stop_after_if_expr: None,
                     skip_if_stopped: Some(false),
+                    summary: None,
                 },
                 FlowModule {
                     input_transform: HashMap::new(),
@@ -432,6 +434,7 @@ mod tests {
                     }),
                     stop_after_if_expr: Some("foo = 'bar'".to_string()),
                     skip_if_stopped: None,
+                    summary: None,
                 },
                 FlowModule {
                     input_transform: [(
@@ -446,6 +449,7 @@ mod tests {
                     },
                     stop_after_if_expr: Some("previous.isEmpty()".to_string()),
                     skip_if_stopped: None,
+                    summary: None,
                 },
             ],
             failure_module: Some(FlowModule {
@@ -453,6 +457,7 @@ mod tests {
                 value: FlowModuleValue::Flow { path: "test".to_string() },
                 stop_after_if_expr: Some("previous.isEmpty()".to_string()),
                 skip_if_stopped: None,
+                summary: None,
             }),
         };
         println!("{}", serde_json::json!(fv).to_string());
diff --git a/frontend/src/lib/components/FlowViewer.svelte b/frontend/src/lib/components/FlowViewer.svelte
index 64bb5d9f5b..52d7c7f702 100644
--- a/frontend/src/lib/components/FlowViewer.svelte
+++ b/frontend/src/lib/components/FlowViewer.svelte
@@ -108,6 +108,7 @@
 							</div>
 							<div class="min-w-0 flex-1 pt-1.5 flex justify-between space-x-4 w-full">
 								<div class="w-full">
+									<span class="text-black">{mod?.summary ?? ''}</span>
 									<p class="text-sm text-gray-500">
 										{#if mod?.value?.type == 'script'}
 											Script at path <a
diff --git a/openflow.openapi.yaml b/openflow.openapi.yaml
index 60825408d2..271625cafe 100644
--- a/openflow.openapi.yaml
+++ b/openflow.openapi.yaml
@@ -58,6 +58,8 @@ components:
           type: string
         skip_if_stopped:
           type: boolean
+        summary:
+          type: string
       required:
         - input_transform
         - value