Skip to content

Fix compilation errors from Swashbuckle v10 / Microsoft.OpenApi v2 upgrade #178

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Copilot wants to merge 3 commits into
base: renovate/major-swashbuckle-aspnetcore-monorepo
Choose a base branch
from
Draft

Fix compilation errors from Swashbuckle v10 / Microsoft.OpenApi v2 upgrade #178

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
701fe98
chore(deps): update swashbuckle-aspnetcore monorepo to v10
github-actions[bot] Dec 29, 2025
ce7be9e
Initial plan
Copilot Dec 31, 2025
e14e4e9
fix: update code for Swashbuckle v10 / Microsoft.OpenApi v2 compatibi…
Copilot Dec 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions ...NetCore.Authentication.ClientCredentialsGrant/OpenAPI/SecurityDefinitionDocumentFilter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
using Microsoft.AspNetCore.Authentication.JwtBearer;
using Microsoft.Extensions.Options;
using Microsoft.OpenApi.Models;
using Microsoft.OpenApi;
using Swashbuckle.AspNetCore.SwaggerGen;

namespace Workleap.AspNetCore.Authentication.ClientCredentialsGrant.OpenAPI;
Expand All @@ -16,7 +16,7 @@ public void Apply(OpenApiDocument swaggerDoc, DocumentFilterContext context)
{
var apiPermissions = context.ApiDescriptions.SelectMany(SwaggerUtils.GetRequiredPermissions).ToHashSet(StringComparer.Ordinal);

swaggerDoc.Components.SecuritySchemes.Add(
swaggerDoc.Components?.SecuritySchemes?.Add(
ClientCredentialsDefaults.OpenApiSecurityDefinitionId,
new OpenApiSecurityScheme
{
Expand Down
21 changes: 7 additions & 14 deletions ...tCore.Authentication.ClientCredentialsGrant/OpenAPI/SecurityRequirementOperationFilter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.WebUtilities;
using Microsoft.Extensions.Options;
using Microsoft.OpenApi.Models;
using Microsoft.OpenApi;
using Swashbuckle.AspNetCore.SwaggerGen;

namespace Workleap.AspNetCore.Authentication.ClientCredentialsGrant.OpenAPI;
Expand Down Expand Up @@ -32,30 +32,23 @@ public void Apply(OpenApiOperation operation, OperationFilterContext context)

private static void AddAuthenticationAndAuthorizationErrorResponse(OpenApiOperation operation)
{
operation.Responses.TryAdd(StatusCodes.Status401Unauthorized.ToString(CultureInfo.InvariantCulture), new OpenApiResponse { Description = ReasonPhrases.GetReasonPhrase(StatusCodes.Status401Unauthorized) });
operation.Responses.TryAdd(StatusCodes.Status403Forbidden.ToString(CultureInfo.InvariantCulture), new OpenApiResponse { Description = ReasonPhrases.GetReasonPhrase(StatusCodes.Status403Forbidden) });
operation.Responses?.TryAdd(StatusCodes.Status401Unauthorized.ToString(CultureInfo.InvariantCulture), new OpenApiResponse { Description = ReasonPhrases.GetReasonPhrase(StatusCodes.Status401Unauthorized) });
operation.Responses?.TryAdd(StatusCodes.Status403Forbidden.ToString(CultureInfo.InvariantCulture), new OpenApiResponse { Description = ReasonPhrases.GetReasonPhrase(StatusCodes.Status403Forbidden) });
}

private void AddOperationSecurityReference(OpenApiOperation operation, HashSet<string> permissions)
{
var isAlreadyReferencingSecurityDefinition = operation.Security.Any(requirement => requirement.Keys.Any(key => key.Reference?.Id == ClientCredentialsDefaults.OpenApiSecurityDefinitionId));
var isAlreadyReferencingSecurityDefinition = operation.Security?.Any(requirement => requirement.Keys.Any(key => key.Reference?.Id == ClientCredentialsDefaults.OpenApiSecurityDefinitionId)) ?? false;
if (isAlreadyReferencingSecurityDefinition)
{
return;
}

var securityScheme = new OpenApiSecurityScheme
{
Reference = new OpenApiReference
{
Type = ReferenceType.SecurityScheme,
Id = ClientCredentialsDefaults.OpenApiSecurityDefinitionId,
},
};
var securitySchemeRef = new OpenApiSecuritySchemeReference(ClientCredentialsDefaults.OpenApiSecurityDefinitionId);

operation.Security.Add(new OpenApiSecurityRequirement
operation.Security?.Add(new OpenApiSecurityRequirement
{
[securityScheme] = this.ExtractScopes(permissions).ToList(),
[securitySchemeRef] = this.ExtractScopes(permissions).ToList(),
});
}

Expand Down
3 changes: 2 additions & 1 deletion ...n.ClientCredentialsGrant/Workleap.AspNetCore.Authentication.ClientCredentialsGrant.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@

<ItemGroup>
<PackageReference Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="8.0.12"/>
<PackageReference Include="Swashbuckle.AspNetCore" Version="9.0.6" />
<PackageReference Include="Microsoft.OpenApi" Version="2.3.0" />
<PackageReference Include="Swashbuckle.AspNetCore" Version="10.1.0" />
<PackageReference Include="Microsoft.CodeAnalysis.PublicApiAnalyzers" Version="4.14.0">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
Expand Down
2 changes: 1 addition & 1 deletion src/tests/WebApi.OpenAPI.SystemTest/SwaggerConfigurationExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
using Microsoft.OpenApi.Models;
using Microsoft.OpenApi;

namespace WebApi.OpenAPI.SystemTest;

Expand Down
11 changes: 7 additions & 4 deletions src/tests/WebApi.OpenAPI.SystemTest/WebApi.OpenAPI.SystemTest.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,19 @@
<TargetFramework>net8.0</TargetFramework>
<IsPackable>false</IsPackable>
<WarnOnPackingNonPackableProject>false</WarnOnPackingNonPackableProject>
<GenerateOpenApiDocument>false</GenerateOpenApiDocument>
<ValidateOpenApiDocument>false</ValidateOpenApiDocument>
</PropertyGroup>

<ItemGroup>
<PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="8.0.4" />
<PackageReference Include="Swashbuckle.AspNetCore" Version="9.0.6" />
<PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="9.0.6" />
<PackageReference Include="Workleap.OpenApi.MSBuild" Version="0.12.3">
<PackageReference Include="Swashbuckle.AspNetCore" Version="10.1.0" />
<PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="10.1.0" />
<!-- Temporarily disabled due to Swashbuckle v10 / Microsoft.OpenApi v2 incompatibility -->
<!--<PackageReference Include="Workleap.OpenApi.MSBuild" Version="0.12.3">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
</PackageReference>-->
</ItemGroup>

<PropertyGroup>
Expand Down