NuGet governance remediation for Mapbox.Api

davidnmbond · davidnmbond · commit b7e26b454a9d · 2026-04-05T16:48:04.000+01:00
diff --git a/Directory.Packages.props b/Directory.Packages.props
@@ -11,9 +11,7 @@
     <PackageVersion Include="Microsoft.Extensions.Logging" Version="10.0.5" />
     <PackageVersion Include="Neovolve.Logging.Xunit.v3" Version="7.2.0" />
     <PackageVersion Include="Nerdbank.GitVersioning" Version="3.9.50" />
-    <PackageVersion Include="Newtonsoft.Json" Version="13.0.4" />
     <PackageVersion Include="refit" Version="10.1.6" />
-    <PackageVersion Include="Refit.Newtonsoft.Json" Version="10.1.6" />
     <PackageVersion Include="SecurityCodeScan.VS2019" Version="5.6.7" />
     <PackageVersion Include="xunit.v3" Version="3.2.2" />
     <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="18.3.0" />
diff --git a/Mapbox.Api.Test/Config/Configuration.cs b/Mapbox.Api.Test/Config/Configuration.cs
@@ -1,18 +1,15 @@
 ﻿using Mapbox.Api.Exceptions;
-using System.Runtime.Serialization;
 
 namespace Mapbox.Api.Test.Config;
 
 /// <summary>
 /// Test configuration
 /// </summary>
-[DataContract]
 public class Configuration
 {
 	/// <summary>
 	/// Mapbox client options
 	/// </summary>
-	[DataMember(Name = "MapboxClientOptions")]
 	public MapboxClientOptions MapboxClientOptions { get; set; } = null!;
 
 	public void Validate()
diff --git a/Mapbox.Api.Test/Mapbox.Api.Test.csproj b/Mapbox.Api.Test/Mapbox.Api.Test.csproj
@@ -6,6 +6,7 @@
     <OutputType>Exe</OutputType>
     <IsPackable>false</IsPackable>
     <ImplicitUsings>enable</ImplicitUsings>
+    <GenerateDocumentationFile>false</GenerateDocumentationFile>
   </PropertyGroup>
   <ItemGroup>
     <PackageReference Include="AwesomeAssertions" />
@@ -18,7 +19,6 @@
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
     <PackageReference Include="Neovolve.Logging.Xunit.v3" />
-    <PackageReference Include="Newtonsoft.Json" />
     <PackageReference Include="SecurityCodeScan.VS2019">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
diff --git a/Mapbox.Api.Test/MapboxClientTest.cs b/Mapbox.Api.Test/MapboxClientTest.cs
@@ -1,9 +1,9 @@
 ﻿using Mapbox.Api.Exceptions;
 using Mapbox.Api.Test.Config;
 using Neovolve.Logging.Xunit;
-using Newtonsoft.Json;
 using System;
 using System.IO;
+using System.Text.Json;
 using Xunit;
 
 namespace Mapbox.Api.Test;
@@ -36,7 +36,7 @@ protected Configuration GetConfiguration()
 		// Yes
 
 		// Load in the config
-		_configuration = JsonConvert.DeserializeObject<Configuration>(File.ReadAllText(fileInfo.FullName))
+		_configuration = JsonSerializer.Deserialize<Configuration>(File.ReadAllText(fileInfo.FullName))
 			?? throw new FormatException("Invalid configuration format.");
 
 		_configuration.Validate();
diff --git a/Mapbox.Api/AuthenticatedBackingOffHttpClientHandler.cs b/Mapbox.Api/AuthenticatedBackingOffHttpClientHandler.cs
@@ -103,7 +103,7 @@ private async Task LogResponseAsync(HttpResponseMessage response, string logPref
 				var headers = response.Headers;
 				var foundHeader = headers.TryGetValues("Retry-After", out var retryAfterHeaders);
 				var retryAfterSecondsString = foundHeader
-					? retryAfterHeaders.FirstOrDefault() ?? "1"
+					? retryAfterHeaders!.FirstOrDefault() ?? "1"
 					: "1";
 				if (!int.TryParse(retryAfterSecondsString, out var retryAfterSeconds))
 				{
diff --git a/Mapbox.Api/Data/Context.cs b/Mapbox.Api/Data/Context.cs
@@ -1,20 +1,33 @@
-﻿using System.Collections.Generic;
-using System.Runtime.Serialization;
+﻿using System.Text.Json.Serialization;
 
 namespace Mapbox.Api.Data;
 
-[DataContract]
+/// <summary>
+/// A context element providing hierarchy information for a geocoding result.
+/// </summary>
 public class Context
 {
-	[DataMember(Name = "id")]
+	/// <summary>
+	/// The context identifier.
+	/// </summary>
+	[JsonPropertyName("id")]
 	public string Id { get; set; } = null!;
 
-	[DataMember(Name = "text")]
+	/// <summary>
+	/// The context text.
+	/// </summary>
+	[JsonPropertyName("text")]
 	public string Text { get; set; } = null!;
 
-	[DataMember(Name = "wikidata")]
+	/// <summary>
+	/// The Wikidata identifier.
+	/// </summary>
+	[JsonPropertyName("wikidata")]
 	public string Wikidata { get; set; } = null!;
 
-	[DataMember(Name = "short_code")]
+	/// <summary>
+	/// The short code (e.g. region or country code).
+	/// </summary>
+	[JsonPropertyName("short_code")]
 	public string ShortCode { get; set; } = null!;
 }
diff --git a/Mapbox.Api/Data/Feature.cs b/Mapbox.Api/Data/Feature.cs
@@ -1,50 +1,94 @@
 ﻿using System.Collections.Generic;
-using System.Runtime.Serialization;
+using System.Text.Json.Serialization;
 
 namespace Mapbox.Api.Data;
 
-[DataContract]
+/// <summary>
+/// A geocoding feature result.
+/// </summary>
 public class Feature
 {
-	[DataMember(Name = "id")]
+	/// <summary>
+	/// The feature identifier.
+	/// </summary>
+	[JsonPropertyName("id")]
 	public string Id { get; set; } = null!;
 
-	[DataMember(Name = "type")]
+	/// <summary>
+	/// The GeoJSON type.
+	/// </summary>
+	[JsonPropertyName("type")]
 	public string Type { get; set; } = null!;
 
-	[DataMember(Name = "place_type")]
+	/// <summary>
+	/// The place type(s).
+	/// </summary>
+	[JsonPropertyName("place_type")]
 	public IList<string> PlaceType { get; set; } = null!;
 
-	[DataMember(Name = "relevance")]
+	/// <summary>
+	/// The relevance score.
+	/// </summary>
+	[JsonPropertyName("relevance")]
 	public double Relevance { get; set; }
 
-	[DataMember(Name = "properties")]
+	/// <summary>
+	/// The feature properties.
+	/// </summary>
+	[JsonPropertyName("properties")]
 	public Properties Properties { get; set; } = null!;
 
-	[DataMember(Name = "text")]
+	/// <summary>
+	/// The feature text.
+	/// </summary>
+	[JsonPropertyName("text")]
 	public string Text { get; set; } = null!;
 
-	[DataMember(Name = "place_name")]
+	/// <summary>
+	/// The full place name.
+	/// </summary>
+	[JsonPropertyName("place_name")]
 	public string PlaceName { get; set; } = null!;
 
-	[DataMember(Name = "matching_text")]
+	/// <summary>
+	/// The matching text.
+	/// </summary>
+	[JsonPropertyName("matching_text")]
 	public string MatchingText { get; set; } = null!;
 
-	[DataMember(Name = "matching_place_name")]
+	/// <summary>
+	/// The matching place name.
+	/// </summary>
+	[JsonPropertyName("matching_place_name")]
 	public string MatchingPlaceName { get; set; } = null!;
 
-	[DataMember(Name = "center")]
+	/// <summary>
+	/// The center coordinates.
+	/// </summary>
+	[JsonPropertyName("center")]
 	public IList<double> Center { get; set; } = null!;
 
-	[DataMember(Name = "geometry")]
+	/// <summary>
+	/// The feature geometry.
+	/// </summary>
+	[JsonPropertyName("geometry")]
 	public Geometry Geometry { get; set; } = null!;
 
-	[DataMember(Name = "address")]
+	/// <summary>
+	/// The address.
+	/// </summary>
+	[JsonPropertyName("address")]
 	public string Address { get; set; } = null!;
 
-	[DataMember(Name = "context")]
+	/// <summary>
+	/// The context hierarchy.
+	/// </summary>
+	[JsonPropertyName("context")]
 	public IList<Context> Context { get; set; } = null!;
 
-	[DataMember(Name = "bbox")]
+	/// <summary>
+	/// The bounding box.
+	/// </summary>
+	[JsonPropertyName("bbox")]
 	public IList<double> Bbox { get; set; } = null!;
 }
diff --git a/Mapbox.Api/Data/Geocoding.cs b/Mapbox.Api/Data/Geocoding.cs
@@ -1,20 +1,34 @@
 ﻿using System.Collections.Generic;
-using System.Runtime.Serialization;
+using System.Text.Json.Serialization;
 
 namespace Mapbox.Api.Data;
 
-[DataContract]
+/// <summary>
+/// A geocoding response from the Mapbox API.
+/// </summary>
 public class Geocoding
 {
-	[DataMember(Name = "type")]
+	/// <summary>
+	/// The GeoJSON type.
+	/// </summary>
+	[JsonPropertyName("type")]
 	public string Type { get; set; } = null!;
 
-	[DataMember(Name = "query")]
+	/// <summary>
+	/// The query terms.
+	/// </summary>
+	[JsonPropertyName("query")]
 	public IList<string> Query { get; set; } = null!;
 
-	[DataMember(Name = "features")]
+	/// <summary>
+	/// The returned features.
+	/// </summary>
+	[JsonPropertyName("features")]
 	public IList<Feature> Features { get; set; } = null!;
 
-	[DataMember(Name = "attribution")]
+	/// <summary>
+	/// The attribution string.
+	/// </summary>
+	[JsonPropertyName("attribution")]
 	public string Attribution { get; set; } = null!;
 }
diff --git a/Mapbox.Api/Data/Geometry.cs b/Mapbox.Api/Data/Geometry.cs
@@ -1,17 +1,28 @@
 ﻿using System.Collections.Generic;
-using System.Runtime.Serialization;
+using System.Text.Json.Serialization;
 
 namespace Mapbox.Api.Data;
 
-[DataContract]
+/// <summary>
+/// A GeoJSON geometry object.
+/// </summary>
 public class Geometry
 {
-	[DataMember(Name = "type")]
+	/// <summary>
+	/// The geometry type.
+	/// </summary>
+	[JsonPropertyName("type")]
 	public string Type { get; set; } = null!;
 
-	[DataMember(Name = "coordinates")]
+	/// <summary>
+	/// The coordinates of the geometry.
+	/// </summary>
+	[JsonPropertyName("coordinates")]
 	public IList<double> Coordinates { get; set; } = null!;
 
-	[DataMember(Name = "interpolated")]
+	/// <summary>
+	/// Whether the result is interpolated.
+	/// </summary>
+	[JsonPropertyName("interpolated")]
 	public bool? Interpolated { get; set; }
 }
diff --git a/Mapbox.Api/Data/Properties.cs b/Mapbox.Api/Data/Properties.cs
@@ -1,11 +1,15 @@
-﻿using System.Collections.Generic;
-using System.Runtime.Serialization;
+﻿using System.Text.Json.Serialization;
 
 namespace Mapbox.Api.Data;
 
-[DataContract]
+/// <summary>
+/// Properties associated with a geocoding feature.
+/// </summary>
 public class Properties
 {
-	[DataMember(Name = "accuracy")]
+	/// <summary>
+	/// The accuracy of the geocoding result.
+	/// </summary>
+	[JsonPropertyName("accuracy")]
 	public string Accuracy { get; set; } = null!;
 }
diff --git a/Mapbox.Api/Exceptions/ConfigurationException.cs b/Mapbox.Api/Exceptions/ConfigurationException.cs
@@ -2,17 +2,32 @@
 
 namespace Mapbox.Api.Exceptions;
 
+/// <summary>
+/// Thrown when the client configuration is invalid.
+/// </summary>
 public class ConfigurationException : Exception
 {
+	/// <summary>
+	/// Initializes a new instance of the <see cref="ConfigurationException"/> class.
+	/// </summary>
 	public ConfigurationException()
 	{
 	}
 
+	/// <summary>
+	/// Initializes a new instance of the <see cref="ConfigurationException"/> class with a message.
+	/// </summary>
+	/// <param name="message">The error message.</param>
 	public ConfigurationException(string message)
 		: base(message)
 	{
 	}
 
+	/// <summary>
+	/// Initializes a new instance of the <see cref="ConfigurationException"/> class with a message and inner exception.
+	/// </summary>
+	/// <param name="message">The error message.</param>
+	/// <param name="innerException">The inner exception.</param>
 	public ConfigurationException(string message, Exception innerException)
 		: base(message, innerException)
 	{
diff --git a/Mapbox.Api/Interfaces/IGeocoding.cs b/Mapbox.Api/Interfaces/IGeocoding.cs
@@ -14,6 +14,7 @@ public interface IGeocoding
 	/// Gets forward geocoding.
 	/// </summary>
 	/// <param name="location">The location to look up</param>
+	/// <param name="cancellationToken">The cancellation token.</param>
 	/// <returns>Task of Object</returns>
 	[Get("/geocoding/v5/mapbox.places/{location}.json")]
 	Task<Geocoding> GetForwardsAsync(
diff --git a/Mapbox.Api/Mapbox.Api.csproj b/Mapbox.Api/Mapbox.Api.csproj
@@ -23,6 +23,7 @@
   </PropertyGroup>
   <ItemGroup>
     <None Include="Icon.png" Pack="true" PackagePath="" />
+    <None Include="..\README.md" Pack="true" PackagePath="" />
   </ItemGroup>
   <ItemGroup>
     <PackageReference Include="Microsoft.CodeAnalysis.Analyzers">
@@ -38,9 +39,7 @@
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="Newtonsoft.Json" />
     <PackageReference Include="refit" />
-    <PackageReference Include="Refit.Newtonsoft.Json" />
     <PackageReference Include="SecurityCodeScan.VS2019">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
diff --git a/Mapbox.Api/MapboxClient.cs b/Mapbox.Api/MapboxClient.cs
diff --git a/Mapbox.Api/MapboxClientOptions.cs b/Mapbox.Api/MapboxClientOptions.cs

Original file line number	Diff line number	Diff line change
`@@ -103,7 +103,7 @@ private async Task LogResponseAsync(HttpResponseMessage response, string logPref`
`103`	`103`	`var headers = response.Headers;`
`104`	`104`	`var foundHeader = headers.TryGetValues("Retry-After", out var retryAfterHeaders);`
`105`	`105`	`var retryAfterSecondsString = foundHeader`
`106`		`- ? retryAfterHeaders.FirstOrDefault() ?? "1"`
	`106`	`+ ? retryAfterHeaders!.FirstOrDefault() ?? "1"`
`107`	`107`	`: "1";`
`108`	`108`	`if (!int.TryParse(retryAfterSecondsString, out var retryAfterSeconds))`
`109`	`109`	`{`