do not include objects with

null values when serializing
for api output

Author: pyth0n1c

contentctl/output/api_json_output.py

@@ -16,6 +16,8 @@
 
 from contentctl.output.json_writer import JsonWriter
 
+EXCLUDE_NONE: bool = True
+
 
 class ApiJsonOutput:
     output_path: pathlib.Path
@@ -51,7 +53,8 @@ def writeDetections(
                         "source",
                         "nes_fields",
                     ]
-                )
+                ),
+                exclude_none=EXCLUDE_NONE,
             )
             for detection in objects
         ]
@@ -78,7 +81,10 @@ def writeMacros(
         objects: list[Macro],
     ) -> None:
         macros = [
-            macro.model_dump(include=set(["definition", "description", "name"]))
+            macro.model_dump(
+                include=set(["definition", "description", "name"]),
+                exclude_none=EXCLUDE_NONE,
+            )
             for macro in objects
         ]
         for macro in macros:
@@ -111,7 +117,8 @@ def writeStories(
                         "baseline_names",
                         "detections",
                     ]
-                )
+                ),
+                exclude_none=EXCLUDE_NONE,
             )
             for story in objects
         ]
@@ -157,7 +164,8 @@ def writeBaselines(
                         "references",
                         "tags",
                     ]
-                )
+                ),
+                exclude_none=EXCLUDE_NONE,
             )
             for baseline in objects
         ]
@@ -190,7 +198,8 @@ def writeInvestigations(
                         "tags",
                         "lowercase_name",
                     ]
-                )
+                ),
+                exclude_none=EXCLUDE_NONE,
             )
             for investigation in objects
         ]
@@ -218,7 +227,8 @@ def writeLookups(
                         "min_matches",
                         "case_sensitive_match",
                     ]
-                )
+                ),
+                exclude_none=EXCLUDE_NONE,
             )
             for lookup in objects
         ]
@@ -248,7 +258,8 @@ def writeDeployments(
                         "rba",
                         "tags",
                     ]
-                )
+                ),
+                exclude_none=EXCLUDE_NONE,
             )
             for deployment in objects
         ]