v10.1.7

What's Changed

• Support custom data type for DataTypeAttribute by @tayfunyuksel in #3868

New Contributors

• @tayfunyuksel made their first contribution in #3868

Full Changelog: v10.1.6...v10.1.7

v10.1.6

What's Changed

• Fix handling of duplicate enum values for dictionaries by @martincostello in #3839
• Log exception when app fails to start in CLI by @ODukhno in #3853
• Fix missing OpenAPI 3.1 $ref properties by @martincostello in #3859
• Add description for OpenAPI schema references by @martincostello in #3860

New Contributors

• @ODukhno made their first contribution in #3853

Full Changelog: v10.1.5...v10.1.6

v10.1.5

What's Changed

• Bump swagger-ui-dist from 5.31.1 to 5.32.0 in /src/Swashbuckle.AspNetCore.SwaggerUI by @dependabot in #3814
• Migrate to actions/attest by @martincostello in #3815
• Disable secrets-outside-env audit by @martincostello in #3823
• Update zizmor to 1.23.1 by @martincostello in #3825
• Fix null examples by @jgarciadelanoceda in #3803
• Bump dependencies by @martincostello in #3835

Full Changelog: v10.1.4...v10.1.5

v10.1.4

What's Changed

• Bump swagger-ui-dist from 5.31.0 to 5.31.1 in /src/Swashbuckle.AspNetCore.SwaggerUI by @dependabot in #3792
• Return null on example, as it was with OpenApiNull before by @jgarciadelanoceda in #3793

Full Changelog: v10.1.3...v10.1.4

v10.1.3

What's Changed

• Fix null examples being represented as the string "null" by @jgarciadelanoceda in #3788

Full Changelog: v10.1.2...v10.1.3

v10.1.2

What's Changed

• Fix browser caching behaviour by @martincostello in #3772
• Fix document URL serialization by @martincostello in #3773

Full Changelog: v10.1.1...v10.1.2

v10.1.1

What's Changed

• Add cache headers to document URLs endpoint by @Copilot and @martincostello in #3766

New Contributors

• @Copilot made their first contribution in #3766

Full Changelog:

v10.1.0...v10.1.1

v10.1.0

What's Changed

New Features

• Add public method SchemaRepository.ReplaceSchemaId by @bkoelman in #3708

Bug Fixes

• Exclude inherited properties only when base added to AllOf by @John-Paul-R in #3692

Miscellaneous

• Add clarifying example in migration guide to v10 by @markuspalme in #3672
• Add markdown linter by @martincostello in #3673
• Update dependencies by @martincostello in #3685
• Validate OpenAPI documents create valid C# clients by @martincostello in #3686
• End-to-end client validation tests by @martincostello in #3687
• Add NSwag client test by @martincostello in #3689
• Fix GitHub step summaries by @martincostello in #3691
• Clarify compatibility by @martincostello in #3694
• Update zizmor by @martincostello in #3695
• Suppress zizmor false-positive by @martincostello in #3696
• Refactor tests by @martincostello in #3705
• Use NuGet Trusted Publishing by @martincostello in #3574
• Annotate TryLookupByType with nullability hints by @martincostello in #3719
• Bump swagger-ui-dist to 5.31.0 by @dependabot in #3720

New Contributors

• @markuspalme made their first contribution in #3672
• @John-Paul-R made their first contribution in #3692

Full Changelog: v10.0.1...v10.1.0

v10.0.1

What's Changed

• Prepare for OpenAPI.NET 3.0 by @martincostello in #3647
• Fix exception sorting operation tags by @martincostello in #3652
• Improve version table by @martincostello in #3653
• Update migration guide by @martincostello in #3654

Full Changelog: 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

• Update README badges by @martincostello in #3597
• Extend NuGet package validation by @martincostello in #3602
• Support .NET 10 by @martincostello in #3283

Full Changelog: v9.0.6...v10.0.0