Add warning for ASP.NET Core version < 10.0
#2451
Conversation
- Remove trailing and unnecessary white space - Typo correction of British English `behaviour` to American English `behavior` - Fix basic markdown lint issues
|
@microsoft-github-policy-service agree |
|
@baywet @adrian05-ms I think the license/cla check is stuck, the bot never swooped in either.
https://github.com/microsoft/OpenAPI.NET?tab=readme-ov-file#contributing I just yoloed the agree to see if something would happen... |
|
@microsoft-github-policy-service rerun |
| OpenAPI.NET v2 is a major update to the OpenAPI.NET library. This release includes a number of performance improvements, API enhancements, and support for OpenAPI v3.1. | ||
|
|
||
| > [!WARNING] | ||
| > If you are using this library with ASP.NET Core version `< 10.0` then you must remain on version `1.x` as it's not compatible. |
There was a problem hiding this comment.
This isn’t strictly true. It’s not compatible with the Microsoft.AspNetCore.OpenApi library, which depends on Microsoft.OpenApi v1.
If your application doesn’t use that (either directly, or transitively via a dependency such as Swashbuckle.AspNetCore), then you can use v2 with ASP.NET Core 8 and 9.
There was a problem hiding this comment.
@martincostello Oh I thought there was some (non-absorbable)breaking changes affecting < ASP.NET Core 10 based on the maintainers conversation in the linked issue. Thanks I'll prepare a new PR!
(I was actually thinking about pinging you in the issue but didn't want to disturb you 😅)
There was a problem hiding this comment.
It's useable, it's just potentially lot of work due to the breaking changes, but other than where you depend on other dependencies using v1, it can be used. For example for Swashbuckle users, it definitely is breaking and not possible to use until we ship our release that supports v2 in November.
I'd just make the warning not so absolute in its wording.
There was a problem hiding this comment.
Ah that makes sense, I agree. Could you prepare the PR instead I'm on a cellular connection and it's not very stable.
There was a problem hiding this comment.
Let's see how the discussion in the issue you tagged me on pans out first.
Contributes to #2442
Upgrade guide to OpenAPI.NET 2.1beforebehaviourto American EnglishbehaviorIdeally there should be some type of markdown lint that runs on CI and a typo checker (added benefit would avoid typo squatting issues as seen in AzureAD/microsoft-authentication-library-for-dotnet#5278)
I get a markdownlint warning MD025/single-title/single-h1: Multiple top-level headings in the same document for the
# Introductionheader since front matter is being used but I left it as is.