Skip to content

Conversation

@release-please-token-provider
Copy link
Contributor

🤖 I have created a release beep boop

3.0.0 (2025-11-11)

⚠ BREAKING CHANGES

  • adds support for OpenAPI 3.2.0

Features

  • adds support for OpenAPI 3.2.0 (765a8dd)

This PR was generated with Release Please. See documentation.

Updated CHANGELOG to include breaking changes and feature support for OpenAPI 3.2.0.
@baywet baywet enabled auto-merge November 11, 2025 16:30
@baywet baywet merged commit 8a6b06e into main Nov 11, 2025
12 of 15 checks passed
@baywet baywet deleted the release-please--branches--main--components--Microsoft.OpenApi branch November 11, 2025 16:32
@release-please-token-provider
Copy link
Contributor Author

🤖 Created releases:

🌻

@sonarqubecloud
Copy link

@martincostello
Copy link
Contributor

Really frustrating that this shipped today when it's only just been possible to ship stable support to users for .NET 10 GA and Microsoft.OpenApi 2.x.

@baywet
Copy link
Member

baywet commented Nov 11, 2025

Yes, however the standard itself released only a week or two before the code freeze for net 10. And we couldn't plan for that since there was no target date itself for the standard new version. It's unfortunate but dates can't always line up as we want 🙂

@martincostello
Copy link
Contributor

Sure, but it would have been useful to "social media calendar" it, as it were, to let the dust settle a bit first for .NET 10 and .NETConf, and also had some advance notice to make some preparation in Swashbuckle.AspNetCore.

Instead within 2 hours of shipping a new major release that's been in development for 10 months, Swashbuckle.AspNetCore is already targeting an older major version and needs another major release for breaking changes.

@baywet
Copy link
Member

baywet commented Nov 11, 2025

Maybe @captainsafia can provide additional feedback here for the ASP.net support, but as far as I understand it, it won't be available before net 11 (so a year from now?).
As for the version 2.X, it'll receive servicing as documented in the contributing guidelines, while this is not ideal, it'll allow Swashbuckle (and other projects) to get all the support they need.

@martincostello
Copy link
Contributor

martincostello commented Nov 11, 2025

The built-in support for Microsoft.AspNetCore.OpenApi won't be able to use it no. I already tried it out, and the source generator in ASP.NET Core 10 fails to compile if 3.0.0 is used due to the breaking change for OpenApiMediaType to IOpenApiMediaType, so it will need to wait until November 2026 and .NET 11 for use there (in a stable version).

For example from a renovate PR I just got:

Error: /home/runner/work/alexa-london-travel-site/alexa-london-travel-site/artifacts/obj/LondonTravel.Site/release/Microsoft.AspNetCore.OpenApi.SourceGenerators/Microsoft.AspNetCore.OpenApi.SourceGenerators.XmlCommentGenerator/OpenApiXmlCommentSupport.generated.cs(725,41): error CS0200: Property or indexer 'IOpenApiMediaType.Example' cannot be assigned to -- it is read only [/home/runner/work/alexa-london-travel-site/alexa-london-travel-site/src/LondonTravel.Site/LondonTravel.Site.csproj]

I've already opened a PR for Swashbuckle.AspNetCore which should be able to adopt it relatively soon (domaindrivendev/Swashbuckle.AspNetCore#3646) as it isn't as tied to Microsoft.AspNetCore.OpenApi for .NET 10+. I just need to test it more and see what happens in some real ASP.NET Core apps.

Unfortunately I have a hunch that I'll now get a bunch of bug reports from people who'll "just update everything to latest" and then report that Swashbuckle.AspNetCore doesn't work with Microsoft.OpenApi 3.x.

If there'd been a bit of coordination and breathing room, that could have maybe been avoided or deferred for a bit. Of course I'm making an assumption here and maybe it'll all be fine in reality, but past experience with new major .NET releases doesn't make me hopeful.

@baywet
Copy link
Member

baywet commented Nov 11, 2025

Thank you for the additional information.

Sorry, I got mixed up, I though Swashbuckle was always relying on Microsoft.AspNetCore.OpenApi but it's not the case. No I understand the initial frustration better. Swashbuckle (the part that generates the OpenAPI description) could have essentially "skipped" v2, and gone straight to v3 have you had a heads up. It doesn't need to wait for net 11. Sorry about that.

Let us know if you find that some specific documentation or release note can be improved for this scenario. (v10 people need to stay on v2, v11 people on v3)

@martincostello
Copy link
Contributor

FYI, here's an example of an issue from a user updating everything as part of their .NET 10 upgrade and then finding things don't work: dotnet/aspnetcore#64317

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants