feat: add JsonConverter for OpenApiSchema System.Text.Json serialization#2915
Merged
baywet merged 8 commits intoJul 2, 2026
Merged
Conversation
baywet
reviewed
Jun 29, 2026
baywet
left a comment
Member
There was a problem hiding this comment.
Thanks for the contribution!
Let's a couple of comments to help get this merged
baywet
reviewed
Jun 30, 2026
There was a problem hiding this comment.
Pull request overview
This PR introduces first-class System.Text.Json (de)serialization support for OpenApiSchema by adding a dedicated JsonConverter<OpenApiSchema> that emits/consumes OpenAPI wire-format JSON instead of default reflection-based output, addressing the need described in #2299.
Changes:
- Added
OpenApiSchemaJsonConverterwith version-targeted serialization (defaulting to OpenAPI 3.2) and deserialization support. - Added unit tests validating basic serialize/deserialize and version-specific behavior.
- Updated public API baselines to include the new converter; also includes an encoding-only change to
global.json.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
src/Microsoft.OpenApi/Converters/OpenApiSchemaJsonConverter.cs |
New converter implementation for OpenApiSchema using OpenAPI wire-format I/O. |
test/Microsoft.OpenApi.Tests/Converters/OpenApiSchemaJsonConverterTests.cs |
New unit tests covering basic serialization/deserialization scenarios. |
src/Microsoft.OpenApi/PublicAPI.Unshipped.txt |
Declares the newly added public converter API surface. |
global.json |
Introduces a UTF-8 BOM at file start (encoding-only change). |
Signed-off-by: Vincent Biret <vibiret@microsoft.com>
Signed-off-by: Vincent Biret <vibiret@microsoft.com>
Signed-off-by: Vincent Biret <vibiret@microsoft.com>
baywet
approved these changes
Jul 2, 2026
baywet
left a comment
Member
There was a problem hiding this comment.
Thank you for making the changes!
peombwa
approved these changes
Jul 2, 2026
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
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.
Description
Adds
OpenApiSchemaJsonConverter, aSystem.Text.Json.JsonConverter<OpenApiSchema>that produces clean OpenAPI wire format output instead of the default verbose reflection-based serialization.Type of Change
Related Issue(s)
Closes #2299
Changes Made
OpenApiSchemaJsonConverterinsrc/Microsoft.OpenApi/Converters/Read(deserialization) support in addition toWrite(serialization)PublicAPI.Unshipped.txtwith new public API surfaceTesting
Checklist
Versions applicability
Additional Notes
Usage example: