Add OpenApiXmlNodeType enum and update OpenApiXml for OAI 3.2.0 support #38
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.
Overview
This PR implements the XML Object updates specified in OpenAPI 3.2.0 specification, introducing a new
NodeType
property while maintaining backward compatibility with earlier OpenAPI versions.Changes
New Functionality
Added
OpenApiXmlNodeType
enum with five values:Element
- represents XML element nodesAttribute
- represents XML attribute nodesText
- represents text nodesCdata
- represents CDATA sectionsNone
- represents no specific node typeAdded
NodeType
property toOpenApiXml
class for explicit XML node type specificationBackward Compatibility
The existing
Attribute
andWrapped
boolean properties are now marked as obsolete but remain fully functional:Attribute
property (obsolete):true
whenNodeType == OpenApiXmlNodeType.Attribute
NodeType
toAttribute
whentrue
,None
whenfalse
Wrapped
property (obsolete):true
whenNodeType == OpenApiXmlNodeType.Element
NodeType
toElement
whentrue
,None
whenfalse
Version-Specific Serialization
The serialization behavior now depends on the OpenAPI specification version:
OpenAPI 3.2.0 and above:
OpenAPI 3.1.0 and below:
This ensures documents remain compatible with their target specification version.
Deserialization Support
All deserializers (V2, V3, V3.1, V32) have been updated:
nodeType
fieldattribute
andwrapped
fieldsTesting
Example Usage
Fixes microsoft#89
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/Release/net8.0/Microsoft.OpenApi.Hidi.Tests.runtimeconfig.json --depsfile /home/REDACTED/work/OpenAPI.NET/OpenAPI.NET/test/Microsoft.OpenApi.Hidi.Tests/bin/Release/net8.0/Microsoft.OpenApi.Hidi.Tests.deps.json /home/REDACTED/work/OpenAPI.NET/OpenAPI.NET/test/Microsoft.OpenApi.Hidi.Tests/bin/Release/net8.0/testhost.dll --port 42855 --endpoint 127.0.0.1:042855 --role client --parentprocessid 5384 --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.