This repository was archived by the owner on Nov 11, 2025. It is now read-only.
Add support for itemEncoding and prefixEncoding fields in OpenApiMediaType#37
Merged
baywet merged 8 commits intoOct 2, 2025
Conversation
…lization support Co-authored-by: baywet <7905502+baywet@users.noreply.github.com>
Co-authored-by: baywet <7905502+baywet@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] add support for the mediaType itemEncoding and prefixEncoding fields
Add support for itemEncoding and prefixEncoding fields in OpenApiMediaType
Oct 1, 2025
Signed-off-by: Vincent Biret <vibiret@microsoft.com>
…b8-ab64-a899005cb84b Signed-off-by: Vincent Biret <vibiret@microsoft.com>
|
@copilot add unit tests for deserialization |
- Added 6 new sample YAML files for testing deserialization - Added 6 new test methods across V3.0, V3.1, and V3.2 deserializers - Fixed typo in OpenApiEncodingDeserializer: "allowedReserved" -> "allowReserved" - Tests verify proper deserialization of itemEncoding and prefixEncoding in native (v3.2) and x-oai- prefixed (v3.0, v3.1) formats Co-authored-by: baywet <7905502+baywet@users.noreply.github.com>
Author
Added comprehensive deserialization tests for
Also fixed a bug in the OpenApiEncodingDeserializer where |
…tps://github.com/BinkyLabs/OpenAPI.NET into copilot/fix-ea45d0db-41a9-4eb8-ab64-a899005cb84b
baywet
approved these changes
Oct 2, 2025
kilifu
approved these changes
Oct 2, 2025
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Summary
This PR implements support for the
itemEncodingandprefixEncodingfields inOpenApiMediaTypeas defined in the OpenAPI 3.2.0 specification.Changes
New Properties
itemEncoding(OpenApiEncoding?): An encoding object for items in an array schemaprefixEncoding(IList<OpenApiEncoding>?): An array of encoding objects for prefixItems in an array schemaVersion-Specific Serialization
Following the pattern established for other 3.2.0 fields:
OpenAPI 3.2.0+: Fields are serialized as native properties
{ "itemEncoding": { "contentType": "text/plain" }, "prefixEncoding": [ { "contentType": "application/json" } ] }OpenAPI 3.1 and earlier: Fields are serialized as
x-oai-prefixed extensions{ "x-oai-itemEncoding": { "contentType": "text/plain" }, "x-oai-prefixEncoding": [ { "contentType": "application/json" } ] }Implementation Details
ItemEncodingandPrefixEncodingtoOpenApiConstantsOpenApiMediaTypewith proper copy constructor supportSerializeInternalto handle version-specific outputPublicApi.approved.txtto reflect the new public surfaceOpenApiEncodingDeserializerwhereallowedReservedwas misspelled (should beallowReserved)Testing
All existing tests pass, plus 10 new tests covering:
Fixes
Resolves the issue by providing full support for these OAI 3.2.0 media type fields with backward compatibility for earlier versions.
Warning
example.org926f4f21-88e7-4dc5-bf88-6c529bb77844/usr/share/dotnet/dotnet exec --runtimeconfig /home/REDACTED/work/OpenAPI.NET/OpenAPI.NET/test/Microsoft.OpenApi.Hidi.Tests/bin/Debug/net8.0/Microsoft.OpenApi.Hidi.Tests.runtimeconfig.json --depsfile /home/REDACTED/work/OpenAPI.NET/OpenAPI.NET/test/Microsoft.OpenApi.Hidi.Tests/bin/Debug/net8.0/Microsoft.OpenApi.Hidi.Tests.deps.json /home/REDACTED/work/OpenAPI.NET/OpenAPI.NET/test/Microsoft.OpenApi.Hidi.Tests/bin/Debug/net8.0/testhost.dll --port 33553 --endpoint 127.0.0.1:033553 --role client --parentprocessid 6047 --telemetryoptedin false(dns block)/usr/share/dotnet/dotnet exec --runtimeconfig /home/REDACTED/work/OpenAPI.NET/OpenAPI.NET/test/Microsoft.OpenApi.Hidi.Tests/bin/Debug/net8.0/Microsoft.OpenApi.Hidi.Tests.runtimeconfig.json --depsfile /home/REDACTED/work/OpenAPI.NET/OpenAPI.NET/test/Microsoft.OpenApi.Hidi.Tests/bin/Debug/net8.0/Microsoft.OpenApi.Hidi.Tests.deps.json /home/REDACTED/work/OpenAPI.NET/OpenAPI.NET/test/Microsoft.OpenApi.Hidi.Tests/bin/Debug/net8.0/testhost.dll --port 38053 --endpoint 127.0.0.1:038053 --role client --parentprocessid 11070 --telemetryoptedin false(dns block)If you need me to access, download, or install something from one of these locations, you can either:
Fixes #10
Original prompt
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.