feat: added description and comment

crates/context_aware_config/migrations/2024-11-06-123105_add_description_and_comment_columns/down.sql

@@ -0,0 +1,20 @@
+ALTER TABLE public.config_versions DROP COLUMN IF EXISTS description;
+ALTER TABLE public.config_versions DROP COLUMN IF EXISTS change_reason;
+
+ALTER TABLE public.functions ALTER COLUMN description DROP NOT NULL;
+ALTER TABLE public.functions ALTER COLUMN description DROP DEFAULT;
+ALTER TABLE public.functions DROP COLUMN IF EXISTS change_reason;
+
+ALTER TABLE public.functions RENAME COLUMN description TO function_description;
+
+ALTER TABLE public.type_templates DROP COLUMN IF EXISTS description;
+ALTER TABLE public.type_templates DROP COLUMN IF EXISTS change_reason;
+
+ALTER TABLE public.default_configs DROP COLUMN IF EXISTS description;
+ALTER TABLE public.default_configs DROP COLUMN IF EXISTS change_reason;
+
+ALTER TABLE public.dimensions DROP COLUMN IF EXISTS description;
+ALTER TABLE public.dimensions DROP COLUMN IF EXISTS change_reason;
+
+ALTER TABLE public.contexts DROP COLUMN IF EXISTS description;
+ALTER TABLE public.contexts DROP COLUMN IF EXISTS change_reason;

crates/context_aware_config/migrations/2024-11-06-123105_add_description_and_comment_columns/up.sql

@@ -0,0 +1,21 @@
+
+ALTER TABLE public.contexts ADD COLUMN IF NOT EXISTS description TEXT DEFAULT '' NOT NULL;
+ALTER TABLE public.contexts ADD COLUMN IF NOT EXISTS change_reason TEXT DEFAULT '' NOT NULL;
+
+ALTER TABLE public.dimensions ADD COLUMN IF NOT EXISTS description TEXT DEFAULT '' NOT NULL;
+ALTER TABLE public.dimensions ADD COLUMN IF NOT EXISTS change_reason TEXT DEFAULT '' NOT NULL;
+
+ALTER TABLE public.default_configs ADD COLUMN IF NOT EXISTS description TEXT DEFAULT '' NOT NULL;
+ALTER TABLE public.default_configs ADD COLUMN IF NOT EXISTS change_reason TEXT DEFAULT '' NOT NULL;
+
+ALTER TABLE public.type_templates ADD COLUMN IF NOT EXISTS description TEXT DEFAULT '' NOT NULL;
+ALTER TABLE public.type_templates ADD COLUMN IF NOT EXISTS change_reason TEXT DEFAULT '' NOT NULL;
+
+ALTER TABLE public.functions RENAME COLUMN function_description TO description;
+ALTER TABLE public.functions ADD COLUMN IF NOT EXISTS change_reason TEXT DEFAULT '' NOT NULL;
+
+ALTER TABLE public.functions ALTER COLUMN description SET DEFAULT '';
+ALTER TABLE public.functions ALTER COLUMN description SET NOT NULL; 
+
+ALTER TABLE public.config_versions ADD COLUMN IF NOT EXISTS description TEXT DEFAULT '' NOT NULL;
+ALTER TABLE public.config_versions ADD COLUMN IF NOT EXISTS change_reason TEXT DEFAULT '' NOT NULL;

crates/context_aware_config/src/api/config/handlers.rs

@@ -380,10 +380,31 @@ fn construct_new_payload(
             },
         )?;
 
-    return Ok(web::Json(PutReq {
-        context: context,
+    let description = match res.get("description") {
+        Some(Value::String(s)) => Some(s.clone()),
+        Some(_) => {
+            log::error!("construct new payload: Description is not a valid string");
+            return Err(bad_argument!("Description must be a string"));
+        }
+        None => None,
+    };
+
+    // Handle change_reason
+    let change_reason = res
+        .get("change_reason")
+        .and_then(|val| val.as_str())
+        .map(|s| s.to_string())
+        .ok_or_else(|| {
+            log::error!("construct new payload: Change reason not present or invalid");
+            bad_argument!("Change reason is required and must be a string")
+        })?;
+
+    Ok(web::Json(PutReq {
+        context,
         r#override: override_,
-    }));
+        description,
+        change_reason,
+    }))
 }
 
 #[allow(clippy::too_many_arguments)]