Skip to content

Update dependency Swashbuckle.AspNetCore to v10

krandorrequested to merge
renovate/major-swashbuckle-aspnetcore-monorepo into master

This MR contains the following updates:

Package Type Update Change
Swashbuckle.AspNetCore nuget major 6.9.0 -> 10.0.1

Release Notes

domaindrivendev/Swashbuckle.AspNetCore (Swashbuckle.AspNetCore)

v10.0.1

What's Changed

Full Changelog: https://github.com/domaindrivendev/Swashbuckle.AspNetCore/compare/v10.0.0...v10.0.1

v10.0.0

Swashbuckle.AspNetCore v10.0.0

[!IMPORTANT]
This release contains major breaking changes.

Read our v10 migration guide for further information.

With this release, Swashbuckle.AspNetCore adds support for generating OpenAPI 3.1 documents and for ASP.NET Core 10.

Swashbuckle.AspNetCore v10 depends on OpenAPI.NET v2.3 which introduces many breaking changes to the public API surface. More information can be found in their OpenAPI.NET v2 Upgrade Guide.

To reduce the number of breaking behavioural changes in Swashbuckle.AspNetCore v10, generation of OpenAPI 3.1 documents is opt-in. To generate OpenAPI 3.1 documents, change the OpenAPI version as shown in the code snippet below:

app.UseSwagger(options =>
{
    options.OpenApiVersion = OpenApiSpecVersion.OpenApi3_1;
});

[!TIP] It is strongly recommended that you upgrade to Swashbuckle.AspNetCore v9.0.6 before upgrading to v10.

[!IMPORTANT]
Use of Swashbuckle.AspNetCore with the ASP.NET Core WithOpenApi() method is no longer supported.

What's Changed

Full Changelog: https://github.com/domaindrivendev/Swashbuckle.AspNetCore/compare/v9.0.6...v10.0.0

v9.0.6

What's Changed

Full Changelog: https://github.com/domaindrivendev/Swashbuckle.AspNetCore/compare/v9.0.5...v9.0.6

v9.0.5

What's Changed

Full Changelog: https://github.com/domaindrivendev/Swashbuckle.AspNetCore/compare/v9.0.4...v9.0.5

v9.0.4

What's Changed

New Contributors

Full Changelog: https://github.com/domaindrivendev/Swashbuckle.AspNetCore/compare/v9.0.3...v9.0.4

v9.0.3

What's Changed

Full Changelog: https://github.com/domaindrivendev/Swashbuckle.AspNetCore/compare/v9.0.2...v9.0.3

v9.0.2

What's Changed

New Contributors

Full Changelog: https://github.com/domaindrivendev/Swashbuckle.AspNetCore/compare/v9.0.1...v9.0.2

v9.0.1

What's Changed

Full Changelog: https://github.com/domaindrivendev/Swashbuckle.AspNetCore/compare/v9.0.0...v9.0.1

v9.0.0

📣 This release contains the following breaking changes:

  • Drops support for netstandard2.0 and thus .NET Framework - now only net8.0 and net9.0 are supported.
  • Removes all public members annotated as [Obsolete] in previous releases.
  • Removes the deprecated --serializeasv2 option from Swashbuckle.AspNetCore.Cli, which was superseded by --openapiversion from version 8.0.0.

What's Changed

Full Changelog: https://github.com/domaindrivendev/Swashbuckle.AspNetCore/compare/v8.1.4...v9.0.0

v8.1.4

What's Changed

Full Changelog: https://github.com/domaindrivendev/Swashbuckle.AspNetCore/compare/v8.1.3...v8.1.4

v8.1.3

What's Changed

New Contributors

Full Changelog: https://github.com/domaindrivendev/Swashbuckle.AspNetCore/compare/v8.1.2...v8.1.3

v8.1.2

What's Changed

New Contributors

Full Changelog: https://github.com/domaindrivendev/Swashbuckle.AspNetCore/compare/v8.1.1...v8.1.2

v8.1.1

What's Changed

Full Changelog: https://github.com/domaindrivendev/Swashbuckle.AspNetCore/compare/v8.1.0...v8.1.1

v8.1.0

What's Changed

Full Changelog: https://github.com/domaindrivendev/Swashbuckle.AspNetCore/compare/v8.0.0...v8.1.0

v8.0.0

[!IMPORTANT]
Swashbuckle.AspNetCore drops support for .NET 6.

Swashbuckle.AspNetCore v8.0.0 makes the following notable changes:

  • Drops support for net6.0.
  • The netstandard2.0 TFM now depends on ASP.NET Core 2.3 instead of ASP.NET Core 2.1.
  • Updates Microsoft.OpenApi to v1.6.23. This update requires the use of swagger-ui v5.19.0 or later (v5.20.1 is included in the Swashbuckle.AspNetCore.SwaggerUI NuGet package). You may need to clear your browser's cache to pick up the latest JavaScript files for swagger-ui.
  • To prepare for future support for OpenAPI 3.1 documents, deprecates the SerializeAsV2 property by marking it as [Obsolete]. Users should update their code as illustrated below, depending on their use case: 
    - options.SerializeAsV2 = true;
+ options.OpenApiVersion = Microsoft.OpenApi.OpenApiSpecVersion.OpenApi2_0;

// or if explicitly disabling (the same as the default behaviour)
- options.SerializeAsV2 = false;
+ options.OpenApiVersion = Microsoft.OpenApi.OpenApiSpecVersion.OpenApi3_0;
  • To prepare for future support for OpenAPI 3.1 documents, the Swashbuckle.AspNetCore.Cli tool has deprecated the --serializeasv2 option and logs a warning to the console. Users should update their usage as illustrated below, depending on their use case: 
    - swagger tofile --output [output] [startupassembly] [swaggerdoc] --serializeasv2
+ swagger tofile --output [output] [startupassembly] [swaggerdoc] --openapiversion "2.0"

What's Changed

Full Changelog: https://github.com/domaindrivendev/Swashbuckle.AspNetCore/compare/v7.3.2...v8.0.0

v7.3.2

What's Changed

New Contributors

Full Changelog: https://github.com/domaindrivendev/Swashbuckle.AspNetCore/compare/v7.3.1...v7.3.2

v7.3.1

What's Changed

Full Changelog: https://github.com/domaindrivendev/Swashbuckle.AspNetCore/compare/v7.3.0...v7.3.1

v7.3.0

What's Changed

New Contributors

Full Changelog: https://github.com/domaindrivendev/Swashbuckle.AspNetCore/compare/v7.2.0...v7.3.0

v7.2.0

What's Changed

New Contributors

Full Changelog: https://github.com/domaindrivendev/Swashbuckle.AspNetCore/compare/v7.1.0...v7.2.0

v7.1.0

What's Changed

New Contributors

Full Changelog: https://github.com/domaindrivendev/Swashbuckle.AspNetCore/compare/v7.0.0...v7.1.0

v7.0.0

What's Changed

New Contributors

Full Changelog: https://github.com/domaindrivendev/Swashbuckle.AspNetCore/compare/v6.9.0...v7.0.0

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻️ Rebasing: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this MR and you won't be reminded about this update again.

  • If you want to rebase/retry this MR, check this box

This MR has been generated by Renovate Bot.

Edited by krandor

Merge request reports