Update Swashbuckle.AspNetCore

Update Swashbuckle.AspNetCore to a version that supports ASP.NET Core 10 preview 2 and Microsoft.OpenApi 2.0.0-preview7.

Author: martincostello

src/TodoApp/OpenApi/Swashbuckle/ExampleFilter.cs

@@ -2,6 +2,7 @@
 // Licensed under the Apache 2.0 license. See the LICENSE file in the project root for full license information.
 
 using Microsoft.OpenApi.Models;
+using Microsoft.OpenApi.Models.Interfaces;
 using Swashbuckle.AspNetCore.SwaggerGen;
 
 namespace TodoApp.OpenApi.Swashbuckle;
@@ -16,6 +17,11 @@ public void Apply(OpenApiOperation operation, OperationFilterContext context)
         => Process(operation, context.ApiDescription);
 
     /// <inheritdoc />
-    public void Apply(OpenApiSchema schema, SchemaFilterContext context)
-        => Process(schema, context.Type);
+    public void Apply(IOpenApiSchema schema, SchemaFilterContext context)
+    {
+        if (schema is OpenApiSchema concrete)
+        {
+            Process(concrete, context.Type);
+        }
+    }
 }

src/TodoApp/OpenApi/Swashbuckle/SwashbuckleOpenApiEndpoints.cs

@@ -42,10 +42,8 @@ public static IServiceCollection AddSwashbuckleOpenApi(this IServiceCollection s
                 Type = SecuritySchemeType.Http,
             };
 
-            var reference = new OpenApiSecuritySchemeReference("Bearer");
-
-            options.AddSecurityDefinition(reference.Reference.Id, scheme);
-            options.AddSecurityRequirement(new() { [reference] = [] });
+            options.AddSecurityDefinition("Bearer", scheme);
+            options.AddSecurityRequirement((document) => new() { [new("Bearer", document)] = [] });
 
             // Enable reading OpenAPI metadata from attributes
             options.EnableAnnotations();

src/TodoApp/TodoApp.csproj

@@ -20,8 +20,8 @@
     <PackageReference Include="Microsoft.OpenApi" Version="2.0.0-preview7" />
     <PackageReference Include="Microsoft.TypeScript.MSBuild" Version="5.8.1" PrivateAssets="all" />
     <PackageReference Include="NSwag.AspNetCore" Version="14.2.0" />
-    <PackageReference Include="Swashbuckle.AspNetCore" Version="9.0.0-pr.3283.1134" />
-    <PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="9.0.0-pr.3283.1134" />
+    <PackageReference Include="Swashbuckle.AspNetCore" Version="9.0.0-pr.3283.1238" />
+    <PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="9.0.0-pr.3283.1238" />
   </ItemGroup>
   <ItemGroup>
     <Content Update="package.json;package-lock.json;tsconfig.json" CopyToPublishDirectory="Never" />

tests/TodoApp.Tests/OpenApiTests.Schema_Is_Correct_schemaUrl=swagger.verified.txt

@@ -260,8 +260,8 @@
         properties: {
           text: {
             type: string,
-            description: Gets or sets the text of the Todo item.,
-            nullable: true
+            nullable: true,
+            description: Gets or sets the text of the Todo item.
           }
         },
         additionalProperties: false,
@@ -275,8 +275,8 @@
         properties: {
           id: {
             type: string,
-            description: Gets or sets the ID of the created Todo item.,
-            nullable: true
+            nullable: true,
+            description: Gets or sets the ID of the created Todo item.
           }
         },
         additionalProperties: false,
@@ -298,8 +298,8 @@
           },
           status: {
             type: integer,
-            format: int32,
-            nullable: true
+            nullable: true,
+            format: int32
           },
           detail: {
             type: string,
@@ -322,22 +322,22 @@
         properties: {
           id: {
             type: string,
-            description: Gets or sets the ID of the Todo item.,
-            nullable: true
+            nullable: true,
+            description: Gets or sets the ID of the Todo item.
           },
           text: {
             type: string,
-            description: Gets or sets the text of the Todo item.,
-            nullable: true
+            nullable: true,
+            description: Gets or sets the text of the Todo item.
           },
           isCompleted: {
             type: boolean,
             description: Gets or sets a value indicating whether the Todo item has been completed.
           },
           lastUpdated: {
             type: string,
-            description: Gets or sets the date and time the Todo item was last updated.,
-            nullable: true
+            nullable: true,
+            description: Gets or sets the date and time the Todo item was last updated.
           }
         },
         additionalProperties: false,
@@ -353,11 +353,11 @@
         properties: {
           items: {
             type: array,
+            nullable: true,
             items: {
               $ref: #/components/schemas/TodoItemModel
             },
-            description: Gets or sets the Todo item(s).,
-            nullable: true
+            description: Gets or sets the Todo item(s).
           }
         },
         additionalProperties: false,

tests/TodoApp.Tests/OpenApiTests.cs

@@ -26,7 +26,7 @@ public OpenApiTests(TodoAppFixture fixture, ITestOutputHelper outputHelper)
     [Theory]
     [InlineData("/nswag/v1.json")]
     [InlineData("/openapi/v1.json", Skip = "https://github.com/dotnet/aspnetcore/issues/61038")]
-    [InlineData("/swagger/v1/swagger.json", Skip = "Depends on a version of Swashbuckle.AspNetCore that supports Microsoft.OpenApi 2.0.0-preview7.")]
+    [InlineData("/swagger/v1/swagger.json", Skip = "https://github.com/microsoft/OpenAPI.NET/issues/2300")]
     public async Task Schema_Is_Correct(string schemaUrl)
     {
         // Arrange
@@ -49,7 +49,7 @@ public async Task Schema_Is_Correct(string schemaUrl)
     [Theory]
     [InlineData("/nswag/v1.json")]
     [InlineData("/openapi/v1.json")]
-    [InlineData("/swagger/v1/swagger.json", Skip = "Depends on a version of Swashbuckle.AspNetCore that supports Microsoft.OpenApi 2.0.0-preview7.")]
+    [InlineData("/swagger/v1/swagger.json")]
     public async Task Schema_Has_No_Validation_Warnings(string schemaUrl)
     {
         // Arrange