Add explicit JsonPropertyNameAttribute to models

Author: JamieMagee

src/Microsoft.ComponentDetection.Contracts/BcdeModels/ContainerDetails.cs

@@ -3,6 +3,7 @@ namespace Microsoft.ComponentDetection.Contracts.BcdeModels;
 
 using System;
 using System.Collections.Generic;
+using System.Text.Json.Serialization;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Serialization;
 
@@ -13,33 +14,41 @@ public class ContainerDetails
 {
     // Summary:
     //     ImageId for the docker container.
+    [JsonPropertyName("imageId")]
     public string ImageId { get; set; }
 
     // Summary:
     //     Unique id for the container.
+    [JsonPropertyName("id")]
     public int Id { get; set; }
 
     // Summary:
     //     Digests for the container
+    [JsonPropertyName("digests")]
     public IEnumerable<string> Digests { get; set; }
 
     // Summary:
     //     The Repository:Tag for the base image of the docker container
     //     ex: alpine:latest || alpine:v3.1 || mcr.microsoft.com/dotnet/sdk:5.0
+    [JsonPropertyName("baseImageRef")]
     public string BaseImageRef { get; set; }
 
     // Summary:
     //     The digest of the exact image used as the base image
     //     This is to avoid errors if there are ref updates between build time and scan time
+    [JsonPropertyName("baseImageDigest")]
     public string BaseImageDigest { get; set; }
 
     // Summary:
     //     The time the container was created
+    [JsonPropertyName("createdAt")]
     public DateTime CreatedAt { get; set; }
 
     // Summary:
     //     Tags for the container
+    [JsonPropertyName("tags")]
     public IEnumerable<string> Tags { get; set; }
 
+    [JsonPropertyName("layers")]
     public IEnumerable<DockerLayer> Layers { get; set; }
 }

src/Microsoft.ComponentDetection.Contracts/BcdeModels/DefaultGraphScanResult.cs

@@ -1,11 +1,13 @@
 #nullable disable
 namespace Microsoft.ComponentDetection.Contracts.BcdeModels;
 
+using System.Text.Json.Serialization;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Serialization;
 
 [JsonObject(MemberSerialization.OptOut, NamingStrategyType = typeof(CamelCaseNamingStrategy))]
 public class DefaultGraphScanResult : ScanResult
 {
+    [JsonPropertyName("dependencyGraphs")]
     public DependencyGraphCollection DependencyGraphs { get; set; }
 }

src/Microsoft.ComponentDetection.Contracts/BcdeModels/DependencyGraphWithMetadata.cs

@@ -2,17 +2,22 @@
 namespace Microsoft.ComponentDetection.Contracts.BcdeModels;
 
 using System.Collections.Generic;
+using System.Text.Json.Serialization;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Serialization;
 
 [JsonObject(MemberSerialization.OptOut, NamingStrategyType = typeof(CamelCaseNamingStrategy))]
 public class DependencyGraphWithMetadata
 {
+    [JsonPropertyName("graph")]
     public DependencyGraph Graph { get; set; }
 
+    [JsonPropertyName("explicitlyReferencedComponentIds")]
     public HashSet<string> ExplicitlyReferencedComponentIds { get; set; }
 
+    [JsonPropertyName("developmentDependencies")]
     public HashSet<string> DevelopmentDependencies { get; set; }
 
+    [JsonPropertyName("dependencies")]
     public HashSet<string> Dependencies { get; set; }
 }

src/Microsoft.ComponentDetection.Contracts/BcdeModels/Detector.cs

@@ -2,6 +2,7 @@
 namespace Microsoft.ComponentDetection.Contracts.BcdeModels;
 
 using System.Collections.Generic;
+using System.Text.Json.Serialization;
 using Microsoft.ComponentDetection.Contracts.TypedComponent;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Converters;
@@ -10,12 +11,16 @@ namespace Microsoft.ComponentDetection.Contracts.BcdeModels;
 [JsonObject(MemberSerialization.OptOut, NamingStrategyType = typeof(CamelCaseNamingStrategy))]
 public class Detector
 {
+    [JsonPropertyName("detectorId")]
     public string DetectorId { get; set; }
 
+    [JsonPropertyName("isExperimental")]
     public bool IsExperimental { get; set; }
 
+    [JsonPropertyName("version")]
     public int Version { get; set; }
 
     [JsonProperty(ItemConverterType = typeof(StringEnumConverter))]
+    [JsonPropertyName("supportedComponentTypes")]
     public IEnumerable<ComponentType> SupportedComponentTypes { get; set; }
 }

src/Microsoft.ComponentDetection.Contracts/BcdeModels/DockerLayer.cs

@@ -1,22 +1,28 @@
 #nullable disable
 namespace Microsoft.ComponentDetection.Contracts.BcdeModels;
 
+using System.Text.Json.Serialization;
+
 public class DockerLayer
 {
     // Summary:
     //     the command/script that was executed in order to create the layer.
+    [JsonPropertyName("createdBy")]
     public string CreatedBy { get; set; }
 
     // Summary:
     // The Layer hash (docker inspect) that represents the changes between this layer and the previous layer
+    [JsonPropertyName("diffId")]
     public string DiffId { get; set; }
 
     // Summary:
     //     Whether or not this layer was found in the base image of the container
+    [JsonPropertyName("isBaseImage")]
     public bool IsBaseImage { get; set; }
 
     // Summary:
     //     0-indexed monotonically increasing ID for the order of the layer in the container.
     //     Note: only includes non-empty layers
+    [JsonPropertyName("layerIndex")]
     public int LayerIndex { get; set; }
 }

src/Microsoft.ComponentDetection.Contracts/BcdeModels/ScanResult.cs

@@ -2,23 +2,30 @@
 namespace Microsoft.ComponentDetection.Contracts.BcdeModels;
 
 using System.Collections.Generic;
+using System.Text.Json.Serialization;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Converters;
 using Newtonsoft.Json.Serialization;
 
 [JsonObject(MemberSerialization.OptOut, NamingStrategyType = typeof(CamelCaseNamingStrategy))]
 public class ScanResult
 {
+    [JsonPropertyName("componentsFound")]
     public IEnumerable<ScannedComponent> ComponentsFound { get; set; }
 
+    [JsonPropertyName("detectorsInScan")]
     public IEnumerable<Detector> DetectorsInScan { get; set; }
 
+    [JsonPropertyName("detectorsNotInScan")]
     public IEnumerable<Detector> DetectorsNotInScan { get; set; }
 
+    [JsonPropertyName("containerDetailsMap")]
     public Dictionary<int, ContainerDetails> ContainerDetailsMap { get; set; }
 
-    [JsonConverter(typeof(StringEnumConverter))]
+    [Newtonsoft.Json.JsonConverter(typeof(StringEnumConverter))]
+    [JsonPropertyName("resultCode")]
     public ProcessingResultCode ResultCode { get; set; }
 
+    [JsonPropertyName("sourceDirectory")]
     public string SourceDirectory { get; set; }
 }

src/Microsoft.ComponentDetection.Contracts/BcdeModels/ScannedComponent.cs

@@ -2,31 +2,42 @@
 namespace Microsoft.ComponentDetection.Contracts.BcdeModels;
 
 using System.Collections.Generic;
+using System.Text.Json.Serialization;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Converters;
 using Newtonsoft.Json.Serialization;
 
 [JsonObject(MemberSerialization.OptOut, NamingStrategyType = typeof(CamelCaseNamingStrategy))]
 public class ScannedComponent
 {
+    [JsonPropertyName("locationsFoundAt")]
     public IEnumerable<string> LocationsFoundAt { get; set; }
 
+    [JsonPropertyName("component")]
     public TypedComponent.TypedComponent Component { get; set; }
 
+    [JsonPropertyName("detectorId")]
     public string DetectorId { get; set; }
 
+    [JsonPropertyName("isDevelopmentDependency")]
     public bool? IsDevelopmentDependency { get; set; }
 
-    [JsonConverter(typeof(StringEnumConverter))]
+    [Newtonsoft.Json.JsonConverter(typeof(StringEnumConverter))]
+    [JsonPropertyName("dependencyScope")]
     public DependencyScope? DependencyScope { get; set; }
 
+    [JsonPropertyName("topLevelReferrers")]
     public IEnumerable<TypedComponent.TypedComponent> TopLevelReferrers { get; set; }
 
+    [JsonPropertyName("ancestralReferrers")]
     public IEnumerable<TypedComponent.TypedComponent> AncestralReferrers { get; set; }
 
+    [JsonPropertyName("containerDetailIds")]
     public IEnumerable<int> ContainerDetailIds { get; set; }
 
+    [JsonPropertyName("containerLayerIds")]
     public IDictionary<int, IEnumerable<int>> ContainerLayerIds { get; set; }
 
+    [JsonPropertyName("targetFrameworks")]
     public ISet<string> TargetFrameworks { get; set; }
 }