Skip to content

Commit 3147529

Browse files
committed
fix: add cancellation token parameter to SerializeAsJsonAsync settings overload
1 parent 00ec76d commit 3147529

3 files changed

Lines changed: 6 additions & 4 deletions

File tree

src/Microsoft.OpenApi/Extensions/OpenApiSerializableExtensions.cs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,11 @@ public static Task SerializeAsJsonAsync<T>(this T element, Stream stream, OpenAp
3737
/// <param name="stream">The output stream.</param>
3838
/// <param name="specVersion">The Open API specification version.</param>
3939
/// <param name="settings">Settings controlling JSON output, including <see cref="OpenApiJsonWriterSettings.Terse"/> for compact formatting.</param>
40-
public static Task SerializeAsJsonAsync<T>(this T element, Stream stream, OpenApiSpecVersion specVersion, OpenApiJsonWriterSettings settings)
40+
/// <param name="cancellationToken">The cancellation token.</param>
41+
public static Task SerializeAsJsonAsync<T>(this T element, Stream stream, OpenApiSpecVersion specVersion, OpenApiJsonWriterSettings settings, CancellationToken cancellationToken)
4142
where T : IOpenApiSerializable
4243
{
43-
return element.SerializeAsync(stream, specVersion, OpenApiConstants.Json, settings, CancellationToken.None);
44+
return element.SerializeAsync(stream, specVersion, OpenApiConstants.Json, settings, cancellationToken);
4445
}
4546

4647
/// <summary>

src/Microsoft.OpenApi/PublicAPI.Unshipped.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22
const Microsoft.OpenApi.OpenApiConstants.JsonSchemaExamplesExtension = "x-jsonschema-examples" -> string!
33
const Microsoft.OpenApi.OpenApiConstants.OaiLicenseIdentifier = "x-oai-license-identifier" -> string!
44
static Microsoft.OpenApi.OpenApiSerializableExtensions.SerializeAsJsonAsync<T>(this T element, Microsoft.OpenApi.OpenApiSpecVersion specVersion, Microsoft.OpenApi.OpenApiJsonWriterSettings! settings) -> System.Threading.Tasks.Task<string!>!
5-
static Microsoft.OpenApi.OpenApiSerializableExtensions.SerializeAsJsonAsync<T>(this T element, System.IO.Stream! stream, Microsoft.OpenApi.OpenApiSpecVersion specVersion, Microsoft.OpenApi.OpenApiJsonWriterSettings! settings) -> System.Threading.Tasks.Task!
5+
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!
66
static Microsoft.OpenApi.OpenApiSerializableExtensions.SerializeAsync<T>(this T element, Microsoft.OpenApi.OpenApiSpecVersion specVersion, string! format, Microsoft.OpenApi.OpenApiWriterSettings? settings) -> System.Threading.Tasks.Task<string!>!

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
using System.IO;
2+
using System.Threading;
23
using System.Threading.Tasks;
34
using Xunit;
45

@@ -104,7 +105,7 @@ public async Task SerializeAsJsonAsync_WithTerseSettings_WritesToStream()
104105
var settings = new OpenApiJsonWriterSettings { Terse = true };
105106

106107
using var stream = new MemoryStream();
107-
await parameter.SerializeAsJsonAsync(stream, OpenApiSpecVersion.OpenApi3_1, settings);
108+
await parameter.SerializeAsJsonAsync(stream, OpenApiSpecVersion.OpenApi3_1, settings, CancellationToken.None);
108109

109110
stream.Position = 0;
110111
using var reader = new StreamReader(stream);

0 commit comments

Comments
 (0)