Skip to content

Upgrading Swashbuckle.AspNetCore.Annotations 7 to 8

Breaking7.3.2 → 8.1.4Platform1Deprecated3New1Changed7Fixed4Other23

Full comparisonBack to Swashbuckle.AspNetCore.Annotations
BreakingUpgrade verdict

A platform requirement change.

In plain terms
  • The package no longer targets .NET 6.
  • The SerializeAsV2 setting is being retired; switch to the new OpenApiVersion setting.
  • The command line tool's --serializeasv2 flag is being retired; use --openapiversion instead.
  • Deprecates SerializeAsV2.
Must act 4 items need code or config changes

Target frameworks requirement changed in 8.0.0: .NETStandard2.0, net6.0, net8.0, net9.0 → .NETStandard2.0, net8.0, net9.0.

1 package of its own release moves with it.

What you must change

Platform1
Drops .NET 6 support.
8.0.0GitHub ReleaseSummarizedView source

Deprecations to plan for

Deprecated3
Deprecates the SerializeAsV2 property by marking it as [Obsolete] in preparation for OpenAPI 3.1 support.
SerializeAsV2OpenApiVersionOpenApiSpecVersion.OpenApi2_0OpenApiSpecVersion.OpenApi3_0
8.0.0GitHub ReleaseSummarizedView source
The Swashbuckle.AspNetCore.Cli tool deprecates the --serializeasv2 option and logs a warning to the console.
Swashbuckle.AspNetCore.Cli--serializeasv2--openapiversion
8.0.0GitHub ReleaseSummarizedView source
Deprecates SerializeAsV2.
SerializeAsV2
8.0.0GitHub ReleaseSummarizedView source