comment

Author: danmar

lib/sarifreport.cpp

@@ -183,6 +183,10 @@ std::string SarifReport::serialize(std::string productName) const
     doc["$schema"] = picojson::value("https://docs.oasis-open.org/sarif/sarif/v2.1.0/errata01/os/schemas/sarif-schema-2.1.0.json");
     doc["runs"] = serializeRuns(productName, version);
 
+    // Insert "version" property at the start.
+    // From SARIF specification (https://docs.oasis-open.org/sarif/sarif/v2.1.0/errata01/os/sarif-v2.1.0-errata01-os-complete.html#_Toc141790730):
+    // Although the order in which properties appear in a JSON object value is not semantically significant, the version property SHOULD appear first.
+
     return "{\n  \"version\": \"2.1.0\"," + picojson::value(doc).serialize(true).substr(1);
 }