chore: RuleModuleYamlSpec placeholder

sift-stack · Sep 27, 2024 · e20b58e · e20b58e
1 parent f7b1d7e
commit e20b58e
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/python/lib/sift_py/ingestion/config/yaml/load.py b/python/lib/sift_py/ingestion/config/yaml/load.py
@@ -12,6 +12,7 @@
     ChannelEnumTypeYamlSpec,
     FlowYamlSpec,
     RuleYamlSpec,
+    RuleModuleYamlSpec,
     TelemetryConfigYamlSpec,
 )
 from sift_py.ingestion.rule.config import RuleActionAnnotationKind
@@ -167,7 +168,7 @@ def _validate_yaml(raw_config: Dict[Any, Any]) -> TelemetryConfigYamlSpec:
             raise YamlConfigError._invalid_property(
                 rules,
                 "rules",
-                f"List[{_type_fqn(RuleYamlSpec)}]",
+                f"List[{_type_fqn(RuleYamlSpec)}] or List[{_type_fqn(RuleModuleYamlSpec)}]",
                 None,
             )
 

diff --git a/python/lib/sift_py/ingestion/config/yaml/spec.py b/python/lib/sift_py/ingestion/config/yaml/spec.py
@@ -90,6 +90,15 @@ class FlowYamlSpec(TypedDict):
     channels: List[ChannelConfigYamlSpec]
 
 
+class RuleModuleYamlSpec(TypedDict):
+    """
+    TODO: A nice docstring
+    """
+    name: str
+    namespace: str
+    channel_references: NotRequired[List[Dict[str, ChannelConfigYamlSpec]]]
+
+
 class RuleYamlSpec(TypedDict):
     """
     The formal definition of what a single rule looks like in YAML.