Skip to content

[release/10.0] Limit Microsoft.OpenApi to disallow next major#67772

Merged
wtgodbe merged 3 commits into
release/10.0from
dev/ygerges/limit-openapi-10
Jul 16, 2026
Merged

[release/10.0] Limit Microsoft.OpenApi to disallow next major#67772
wtgodbe merged 3 commits into
release/10.0from
dev/ygerges/limit-openapi-10

Conversation

@Youssef1313

@Youssef1313 Youssef1313 commented Jul 14, 2026

Copy link
Copy Markdown
Member

This mirrors #67771 in release/10.0.

Limit Microsoft.OpenApi to disallow next major

This PR adjusts the dependency on Microsoft.OpenApi to be < 3.0.0 and >= 2.7.5.

Description

Microsoft.OpenApi 2.x and 3.x are not binary compatible. Attempting to update Microsoft.OpenApi in user applications to 3.x while using .NET 10 will fail with errors that are hard to interpret by users. This could either be that the Xml comments source generator producing code with compilation errors, or fail due to other binary incompatibilities at runtime.

Fixes #64317

Customer Impact

Customers will get a more clear error from NuGet that they should keep the dependency on 2.x as 3.0.0+ isn't supported. This is better than failing with cryptic errors in source-generated code.

Regression?

No

Risk

Low

This is a failure case already today.

Verification

From CI artifacts:

image image

Packaging changes reviewed?

  • Yes
  • No
  • N/A

Copilot AI review requested due to automatic review settings July 14, 2026 04:18
@Youssef1313
Youssef1313 requested review from a team and wtgodbe as code owners July 14, 2026 04:18

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the repo’s dependency version configuration to constrain Microsoft.OpenApi / Microsoft.OpenApi.YamlReader so NuGet restore won’t float to the next major version, mirroring release/10.0 PR #67771.

Changes:

  • Changed MicrosoftOpenApiVersion and MicrosoftOpenApiYamlReaderVersion from a fixed version to a (intended) version range in eng/Versions.props.

Comment thread eng/Versions.props Outdated

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

@Youssef1313 Youssef1313 changed the title Limit Microsoft.OpenApi to disallow next major [release/10.0] Limit Microsoft.OpenApi to disallow next major Jul 14, 2026
@Youssef1313 Youssef1313 added the Servicing-approved Shiproom has approved the issue label Jul 15, 2026
@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Hi @Youssef1313. This PR was just approved to be included in the upcoming servicing release. Somebody from the @dotnet/aspnet-build team will get it merged when the branches are open. Until then, please make sure all the CI checks pass and the PR is reviewed.

@wtgodbe
wtgodbe merged commit a538338 into release/10.0 Jul 16, 2026
28 checks passed
@wtgodbe
wtgodbe deleted the dev/ygerges/limit-openapi-10 branch July 16, 2026 15:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Servicing-approved Shiproom has approved the issue

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants