Bump Microsoft.OpenApi from 1.2.3 to 2.3.0 #77
Closed
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.
Updated Microsoft.OpenApi from 1.2.3 to 2.3.0.
Release notes
Sourced from Microsoft.OpenApi's releases.
2.3.0
2.3.0 (2025-08-29)
Features
2.2.0
2.2.0 (2025-08-25)
Features
Bug Fixes
2.1.0
2.1.0 (2025-08-20)
Features
Bug Fixes
2.0.1
2.0.1 (2025-08-18)
Bug Fixes
2.0.0
2.0.0 (2025-07-10)
Features
Bug Fixes
2.0.0-preview9
2.0.0-preview9 (2025-02-21)
Features
Bug Fixes
2.0.0-preview8
2.0.0-preview8 (2025-02-17)
Bug Fixes
2.0.0-preview7
2.0.0-preview7 (2025-02-06)
Bug Fixes
2.0.0-preview6
2.0.0-preview6 (2025-02-05)
Features
Bug Fixes
... (truncated)
2.0.0-preview5
Changes:
See More
... (truncated)
2.0.0-preview4
Changes:
See More
const
keyword in OpenApiSchema... (truncated)
2.0.0-preview3
Changes:
See More
const
keyword in OpenApiSchema... (truncated)
2.0.0-preview2
Changes:
See More
... (truncated)
2.0.0-preview10
2.0.0-preview10 (2025-02-27)
Features
Bug Fixes
2.0.0-preview1
Overview
Version 2.0-preview1 brings major enhancements, including OpenAPI 3.1 support, improved performance, and bug fixes to enhance user experience. These changes introduce some breaking changes, so migrating to this new version may require updates in existing implementations.
Upgrade Steps
Breaking Changes
1. Update namespaces
Since most of the loading code has moved to the core library, you will be required to update the namespaces in your classes to reflect the change.
Example:
If you're using an instance of our
OpenApiReaderSettings
, you'll need to update the namespace fromMicrosoft.OpenApi.Readers
toMicrosoft.OpenApi.Reader
2. Use Load/LoadAsync/Parse pattern for loading OpenApi documents
We've introduced a simplified static loading pattern for OpenAPI documents, removing the need for a secondary reader.
We have also introduced a registry class that allows users to register different OpenAPI format providers and their implementations for customized scenarios.
Reading from a JSON stream:
To enable YAML parsing, you'll have to register our OpenApiYamlReader with our reader registry for us to take a dependency on the SharpYaml library.
Reading from a YAML stream:
Reading string input:
Reading from a file path or URL:
3. Migration to JsonNode for examples and extensions
Schema examples and extensions now use JsonNode instead of IOpenApiAny, ensuring JSON Schema compatibility and fixing parsing errors.
You'll be required to import the
System.Text.Json.Nodes
namespace to facilitate this.v1.x example: