Fix build

- Updates for Microsoft.OpenApi 2.0.0-preview7.
- Use OpenAPI 3.0.
- Skip failing tests.

Author: martincostello

src/TodoApp/OpenApi/AspNetCore/AspNetCoreOpenApiEndpoints.cs

@@ -2,6 +2,8 @@
 // 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 Microsoft.OpenApi.Models.References;
 
 namespace TodoApp.OpenApi.AspNetCore;
 
@@ -14,6 +16,9 @@ public static IServiceCollection AddAspNetCoreOpenApi(this IServiceCollection se
             // Add a document transformer to customise the generated OpenAPI document
             options.AddDocumentTransformer((document, _, _) =>
             {
+                // TODO Use 3.1 when all three OpenAPI implementations support it
+                options.OpenApiVersion = Microsoft.OpenApi.OpenApiSpecVersion.OpenApi3_0;
+
                 // Add a title and version for the OpenAPI document
                 document.Info.Title = "Todo API (ASP.NET Core OpenAPI)";
                 document.Info.Description = "An API for managing Todo items.";
@@ -39,18 +44,15 @@ public static IServiceCollection AddAspNetCoreOpenApi(this IServiceCollection se
                     Description = "Bearer authentication using a JWT.",
                     Scheme = "bearer",
                     Type = SecuritySchemeType.Http,
-                    Reference = new()
-                    {
-                        Id = "Bearer",
-                        Type = ReferenceType.SecurityScheme,
-                    },
                 };
 
+                var reference = new OpenApiSecuritySchemeReference("Bearer", document);
+
                 document.Components ??= new();
-                document.Components.SecuritySchemes ??= new Dictionary<string, OpenApiSecurityScheme>();
-                document.Components.SecuritySchemes[scheme.Reference.Id] = scheme;
+                document.Components.SecuritySchemes ??= new Dictionary<string, IOpenApiSecurityScheme>();
+                document.Components.SecuritySchemes[reference.Reference.Id] = scheme;
                 document.SecurityRequirements ??= [];
-                document.SecurityRequirements.Add(new() { [scheme] = [] });
+                document.SecurityRequirements.Add(new() { [reference] = [] });
 
                 return Task.CompletedTask;
             });

src/TodoApp/OpenApi/ExamplesProcessor.cs

@@ -6,6 +6,7 @@
 using Microsoft.AspNetCore.Mvc.ApiExplorer;
 using Microsoft.AspNetCore.Mvc.ModelBinding;
 using Microsoft.OpenApi.Models;
+using Microsoft.OpenApi.Models.Interfaces;
 
 namespace TodoApp.OpenApi;
 
@@ -56,7 +57,7 @@ protected void Process(OpenApiSchema schema, Type type)
     }
 
     private static void TryAddParameterExamples(
-        IList<OpenApiParameter> parameters,
+        IList<IOpenApiParameter> parameters,
         ApiDescription description,
         IList<IOpenApiExampleMetadata> examples)
     {
@@ -81,8 +82,7 @@ private static void TryAddParameterExamples(
                 if (metadata?.GenerateExample(Context) is { } value)
                 {
                     // Find the parameter that corresponds to the argument and set its example
-                    var parameter = parameters.FirstOrDefault((p) => p.Name == argument.Name);
-                    if (parameter is not null)
+                    if (parameters.FirstOrDefault((p) => p.Name == argument.Name) is OpenApiParameter parameter)
                     {
                         parameter.Example ??= value;
                     }
@@ -92,7 +92,7 @@ private static void TryAddParameterExamples(
     }
 
     private static void TryAddRequestExamples(
-        OpenApiRequestBody body,
+        IOpenApiRequestBody body,
         ApiDescription description,
         IList<IOpenApiExampleMetadata> examples)
     {

src/TodoApp/OpenApi/Swashbuckle/SwashbuckleOpenApiEndpoints.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.References;
 
 namespace TodoApp.OpenApi.Swashbuckle;
 
@@ -39,15 +40,12 @@ public static IServiceCollection AddSwashbuckleOpenApi(this IServiceCollection s
                 Description = "Bearer authentication using a JWT.",
                 Scheme = "bearer",
                 Type = SecuritySchemeType.Http,
-                Reference = new()
-                {
-                    Id = "Bearer",
-                    Type = ReferenceType.SecurityScheme,
-                },
-                UnresolvedReference = false,
             };
-            options.AddSecurityDefinition(scheme.Reference.Id, scheme);
-            options.AddSecurityRequirement(new() { [scheme] = [] });
+
+            var reference = new OpenApiSecuritySchemeReference("Bearer");
+
+            options.AddSecurityDefinition(reference.Reference.Id, scheme);
+            options.AddSecurityRequirement(new() { [reference] = [] });
 
             // Enable reading OpenAPI metadata from attributes
             options.EnableAnnotations();

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

@@ -1,5 +1,5 @@
 {
-  openapi: 3.1.1,
+  openapi: 3.0.4,
   info: {
     title: Todo API (ASP.NET Core OpenAPI),
     description: An API for managing Todo items.,
@@ -285,35 +285,24 @@
         type: object,
         properties: {
           type: {
-            type: [
-              null,
-              string
-            ]
+            type: string,
+            nullable: true
           },
           title: {
-            type: [
-              null,
-              string
-            ]
+            type: string,
+            nullable: true
           },
           status: {
-            type: [
-              null,
-              integer
-            ],
+            type: integer
             format: int32
           },
           detail: {
-            type: [
-              null,
-              string
-            ]
+            type: string,
+            nullable: true
           },
           instance: {
-            type: [
-              null,
-              string
-            ]
+            type: string,
+            nullable: true
           }
         },
         example: {

tests/TodoApp.Tests/OpenApiTests.cs

@@ -23,15 +23,10 @@ public OpenApiTests(TodoAppFixture fixture, ITestOutputHelper outputHelper)
 
     private ITestOutputHelper OutputHelper { get; }
 
-    public static TheoryData<string> OpenApiUrls() => new()
-    {
-        { "/nswag/v1.json" },
-        { "/openapi/v1.json" },
-        ////{ "/swagger/v1/swagger.json" }, // TODO Disabled due to missing schema references
-    };
-
     [Theory]
-    [MemberData(nameof(OpenApiUrls))]
+    [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.")]
     public async Task Schema_Is_Correct(string schemaUrl)
     {
         // Arrange
@@ -52,7 +47,9 @@ public async Task Schema_Is_Correct(string schemaUrl)
     }
 
     [Theory]
-    [MemberData(nameof(OpenApiUrls))]
+    [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.")]
     public async Task Schema_Has_No_Validation_Warnings(string schemaUrl)
     {
         // Arrange