fix: add cancellation token parameter to SerializeAsJsonAsync settings overload

Author: Mahdigln

src/Microsoft.OpenApi/Extensions/OpenApiSerializableExtensions.cs

@@ -38,7 +38,9 @@ public static Task SerializeAsJsonAsync<T>(this T element, Stream stream, OpenAp
         /// <param name="specVersion">The Open API specification version.</param>
         /// <param name="settings">Settings controlling JSON output, including <see cref="OpenApiJsonWriterSettings.Terse"/> for compact formatting.</param>
         /// <param name="cancellationToken">The cancellation token.</param>
-        public static Task SerializeAsJsonAsync<T>(this T element, Stream stream, OpenApiSpecVersion specVersion, OpenApiJsonWriterSettings settings, CancellationToken cancellationToken)
+#pragma warning disable RS0026 // Intentional overload alongside the CancellationToken-only variant; types are unambiguous.
+        public static Task SerializeAsJsonAsync<T>(this T element, Stream stream, OpenApiSpecVersion specVersion, OpenApiJsonWriterSettings settings, CancellationToken cancellationToken = default)
+#pragma warning restore RS0026
             where T : IOpenApiSerializable
         {
             return element.SerializeAsync(stream, specVersion, OpenApiConstants.Json, settings, cancellationToken);
@@ -68,12 +70,14 @@ public static Task SerializeAsYamlAsync<T>(this T element, Stream stream, OpenAp
         /// <param name="specVersion">The Open API specification version.</param>
         /// <param name="format">The output format (JSON or YAML).</param>
         /// <param name="cancellationToken">The cancellation token.</param>
+#pragma warning disable RS0027 // The settings overload below has the same parameter count but different types; no ambiguity exists.
         public static Task SerializeAsync<T>(
             this T element,
             Stream stream,
             OpenApiSpecVersion specVersion,
             string format,
             CancellationToken cancellationToken = default)
+#pragma warning restore RS0027
             where T : IOpenApiSerializable
         {
             return element.SerializeAsync(stream, specVersion, format, null, cancellationToken);
@@ -179,13 +183,17 @@ public static Task<string> SerializeAsJsonAsync<T>(
         /// <param name="element">The Open API element.</param>
         /// <param name="specVersion">The Open API specification version.</param>
         /// <param name="settings">Settings controlling JSON output, including <see cref="OpenApiJsonWriterSettings.Terse"/> for compact formatting.</param>
+        /// <param name="cancellationToken">The cancellation token.</param>
+#pragma warning disable RS0026 // Intentional overload alongside the CancellationToken-only variant; types are unambiguous.
         public static Task<string> SerializeAsJsonAsync<T>(
             this T element,
             OpenApiSpecVersion specVersion,
-            OpenApiJsonWriterSettings settings)
+            OpenApiJsonWriterSettings settings,
+            CancellationToken cancellationToken = default)
+#pragma warning restore RS0026
             where T : IOpenApiSerializable
         {
-            return element.SerializeAsync(specVersion, OpenApiConstants.Json, settings);
+            return element.SerializeAsync(specVersion, OpenApiConstants.Json, settings, cancellationToken);
         }
 
         /// <summary>
@@ -243,21 +251,29 @@ public static async Task<string> SerializeAsync<T>(
         /// <param name="specVersion">The Open API specification version.</param>
         /// <param name="format">Open API document format.</param>
         /// <param name="settings">Provide configuration settings for controlling writing output.</param>
+        /// <param name="cancellationToken">The cancellation token.</param>
+#pragma warning disable RS0026 // Intentional overload alongside the CancellationToken-only variant; types are unambiguous.
         public static async Task<string> SerializeAsync<T>(
             this T element,
             OpenApiSpecVersion specVersion,
             string format,
-            OpenApiWriterSettings? settings)
+            OpenApiWriterSettings? settings,
+            CancellationToken cancellationToken = default)
+#pragma warning restore RS0026
             where T : IOpenApiSerializable
         {
             Utils.CheckArgumentNull(element);
 
             using var stream = new MemoryStream();
-            await element.SerializeAsync(stream, specVersion, format, settings, CancellationToken.None).ConfigureAwait(false);
+            await element.SerializeAsync(stream, specVersion, format, settings, cancellationToken).ConfigureAwait(false);
             stream.Position = 0;
 
             using var streamReader = new StreamReader(stream);
+#if NET7_0_OR_GREATER
+            return await streamReader.ReadToEndAsync(cancellationToken).ConfigureAwait(false);
+#else
             return await streamReader.ReadToEndAsync().ConfigureAwait(false);
+#endif
         }
     }
 }

src/Microsoft.OpenApi/PublicAPI.Unshipped.txt

@@ -1,6 +1,6 @@
 #nullable enable
 const Microsoft.OpenApi.OpenApiConstants.JsonSchemaExamplesExtension = "x-jsonschema-examples" -> string!
 const Microsoft.OpenApi.OpenApiConstants.OaiLicenseIdentifier = "x-oai-license-identifier" -> string!
-static Microsoft.OpenApi.OpenApiSerializableExtensions.SerializeAsJsonAsync<T>(this T element, Microsoft.OpenApi.OpenApiSpecVersion specVersion, Microsoft.OpenApi.OpenApiJsonWriterSettings! settings) -> System.Threading.Tasks.Task<string!>!
-static Microsoft.OpenApi.OpenApiSerializableExtensions.SerializeAsJsonAsync<T>(this T element, System.IO.Stream! stream, Microsoft.OpenApi.OpenApiSpecVersion specVersion, Microsoft.OpenApi.OpenApiJsonWriterSettings! settings, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task!
-static Microsoft.OpenApi.OpenApiSerializableExtensions.SerializeAsync<T>(this T element, Microsoft.OpenApi.OpenApiSpecVersion specVersion, string! format, Microsoft.OpenApi.OpenApiWriterSettings? settings) -> System.Threading.Tasks.Task<string!>!
+static Microsoft.OpenApi.OpenApiSerializableExtensions.SerializeAsJsonAsync<T>(this T element, Microsoft.OpenApi.OpenApiSpecVersion specVersion, Microsoft.OpenApi.OpenApiJsonWriterSettings! settings, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task<string!>!
+static Microsoft.OpenApi.OpenApiSerializableExtensions.SerializeAsJsonAsync<T>(this T element, System.IO.Stream! stream, Microsoft.OpenApi.OpenApiSpecVersion specVersion, Microsoft.OpenApi.OpenApiJsonWriterSettings! settings, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!
+static Microsoft.OpenApi.OpenApiSerializableExtensions.SerializeAsync<T>(this T element, Microsoft.OpenApi.OpenApiSpecVersion specVersion, string! format, Microsoft.OpenApi.OpenApiWriterSettings? settings, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task<string!>!

test/Microsoft.OpenApi.Tests/Extensions/OpenApiSerializableExtensionsTests.cs

@@ -105,7 +105,7 @@ public async Task SerializeAsJsonAsync_WithTerseSettings_WritesToStream()
         var settings = new OpenApiJsonWriterSettings { Terse = true };
 
         using var stream = new MemoryStream();
-        await parameter.SerializeAsJsonAsync(stream, OpenApiSpecVersion.OpenApi3_1, settings, CancellationToken.None);
+        await parameter.SerializeAsJsonAsync(stream, OpenApiSpecVersion.OpenApi3_1, settings, TestContext.Current.CancellationToken);
 
         stream.Position = 0;
         using var reader = new StreamReader(stream);
@@ -126,7 +126,7 @@ public async Task SerializeAsJsonAsync_WithTerseSettings_ReturnsCompactString()
 
         var settings = new OpenApiJsonWriterSettings { Terse = true };
 
-        var output = await parameter.SerializeAsJsonAsync(OpenApiSpecVersion.OpenApi3_1, settings);
+        var output = await parameter.SerializeAsJsonAsync(OpenApiSpecVersion.OpenApi3_1, settings, TestContext.Current.CancellationToken);
 
         Assert.Equal("{\"name\":\"param1\",\"in\":\"query\",\"schema\":{\"type\":\"string\"}}", output);
     }
@@ -143,7 +143,7 @@ public async Task SerializeAsync_WithSettings_ReturnsFormattedString()
 
         var settings = new OpenApiJsonWriterSettings { Terse = false };
 
-        var output = await parameter.SerializeAsync(OpenApiSpecVersion.OpenApi3_1, OpenApiConstants.Json, settings);
+        var output = await parameter.SerializeAsync(OpenApiSpecVersion.OpenApi3_1, OpenApiConstants.Json, settings, TestContext.Current.CancellationToken);
 
         Assert.Equal("{\n  \"name\": \"param1\",\n  \"in\": \"query\",\n  \"schema\": {\n    \"type\": \"string\"\n  }\n}", output);
     }