Add support for itemEncoding and prefixEncoding fields in OpenApiMediaType #37
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
itemEncoding
andprefixEncoding
fields inOpenApiMediaType
as 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
OpenAPI 3.1 and earlier: Fields are serialized as
x-oai-
prefixed extensionsImplementation Details
ItemEncoding
andPrefixEncoding
toOpenApiConstants
OpenApiMediaType
with proper copy constructor supportSerializeInternal
to handle version-specific outputPublicApi.approved.txt
to reflect the new public surfaceTesting
All existing tests pass, plus 4 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
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
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:
Original prompt
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.