Merge pull request #695 from pvdrz/remove-nulls

Skip seralizing null fields on JSON
CycloneDX · May 9, 2024 · b85f788 · b85f788
2 parents b01a876 + 399b7cd
commit b85f788
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 13 deletions.
diff --git a/cyclonedx-bom/src/specs/v1_5/annotation.rs b/cyclonedx-bom/src/specs/v1_5/annotation.rs
@@ -114,6 +114,7 @@ impl FromXml for Annotations {
 #[serde(rename_all = "camelCase")]
 pub(crate) struct Annotation {
     /// Optional identifier to reference the annotation elsewhere in the Bom.
+    #[serde(skip_serializing_if = "Option::is_none")]
     bom_ref: Option<String>,
     /// A list of BOM references, TODO change to `Subjects`
     subjects: Vec<String>,
@@ -124,6 +125,7 @@ pub(crate) struct Annotation {
     /// The textual content of the annotation.
     text: String,
     /// The optional signature
+    #[serde(skip_serializing_if = "Option::is_none")]
     signature: Option<Signature>,
 }
 

diff --git a/...s/1.5/it_should_parse_all_of_the_valid_json_specifications@valid-annotation-1.5.json.snap b/...s/1.5/it_should_parse_all_of_the_valid_json_specifications@valid-annotation-1.5.json.snap
@@ -1,6 +1,5 @@
 ---
 source: cyclonedx-bom/tests/specification_tests_v1_5.rs
-assertion_line: 54
 expression: bom_output
 input_file: cyclonedx-bom/tests/spec/1.5/valid-annotation-1.5.json
 ---
@@ -19,7 +18,6 @@ input_file: cyclonedx-bom/tests/spec/1.5/valid-annotation-1.5.json
   ],
   "annotations": [
     {
-      "bomRef": null,
       "subjects": [
         "component-a"
       ],
@@ -38,11 +36,9 @@ input_file: cyclonedx-bom/tests/spec/1.5/valid-annotation-1.5.json
         }
       },
       "timestamp": "2022-01-01T00:00:00Z",
-      "text": "This is a sample annotation made by an organization",
-      "signature": null
+      "text": "This is a sample annotation made by an organization"
     },
     {
-      "bomRef": null,
       "subjects": [
         "component-a"
       ],
@@ -54,11 +50,9 @@ input_file: cyclonedx-bom/tests/spec/1.5/valid-annotation-1.5.json
         }
       },
       "timestamp": "2022-01-01T00:00:00Z",
-      "text": "This is a sample annotation made by a person",
-      "signature": null
+      "text": "This is a sample annotation made by a person"
     },
     {
-      "bomRef": null,
       "subjects": [
         "component-a"
       ],
@@ -70,11 +64,9 @@ input_file: cyclonedx-bom/tests/spec/1.5/valid-annotation-1.5.json
         }
       },
       "timestamp": "2022-01-01T00:00:00Z",
-      "text": "This is a sample annotation made by a component",
-      "signature": null
+      "text": "This is a sample annotation made by a component"
     },
     {
-      "bomRef": null,
       "subjects": [
         "component-a"
       ],
@@ -105,8 +97,7 @@ input_file: cyclonedx-bom/tests/spec/1.5/valid-annotation-1.5.json
         }
       },
       "timestamp": "2022-01-01T00:00:00Z",
-      "text": "This is a sample annotation made by a service",
-      "signature": null
+      "text": "This is a sample annotation made by a service"
     }
   ]
 }