feat: Add OpenApiJsonWriterSettings parameter to SerializeAsJsonAsync to be able to serialize json to compact format using Terse parameter#2799
Open
rmijacques wants to merge 2 commits intomicrosoft:mainfrom
Conversation
…to be able to serialize json to compact format using Terse parameter
Author
|
@microsoft-github-policy-service agree company="Lucca" |
rmijacques
changed the title
baywet
requested changes
Mar 30, 2026
Member
baywet
left a comment
baywet
left a comment
There was a problem hiding this comment.
Thanks for the contribution!
I believe we'll need to carefully iterate on the changes to maintain the binary and source compatibility here.
| /// <param name="specVersion">Version of the specification the output should conform to</param> | ||
| /// <param name="cancellationToken">The cancellation token.</param> | ||
| public static Task SerializeAsync<T>(this T element, IOpenApiWriter writer, OpenApiSpecVersion specVersion, CancellationToken cancellationToken = default) | ||
| public static Task SerializeAsync<T>(this T element, IOpenApiWriter writer, OpenApiSpecVersion specVersion, CancellationToken cancellationToken) |
Member
There was a problem hiding this comment.
This breaks source and binary compatibility. The cancellationToken is now mandatory for a bunch of the overloads as we can see in the API export.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull Request
Description
Added a setting parameter to SerializeAsJsonAsync to be able to serialize JSON to compact format out of the box.
Type of Change
Related Issue(s)
Fixes #2798
Changes Made
Testing
Checklist
Versions applicability
See the contributing guidelines for more information about how patches are applied across multiple versions.
Additional Notes