Fix integration tests for OpenAPI document

Author: captainsafia

src/OpenApi/sample/Controllers/TestController.cs

@@ -3,6 +3,7 @@
 
 using System.ComponentModel.DataAnnotations;
 using System.Diagnostics.CodeAnalysis;
+using Microsoft.AspNetCore.Http.HttpResults;
 using Microsoft.AspNetCore.Mvc;
 
 [ApiController]
@@ -17,6 +18,13 @@ public string GetByIdAndName(RouteParamsContainer paramsContainer)
         return paramsContainer.Id + "_" + paramsContainer.Name;
     }
 
+    [HttpGet]
+    [Route("/gettypedresult")]
+    public Ok<MvcTodo> GetTypedResult()
+    {
+        return TypedResults.Ok(new MvcTodo("Title", "Description", true));
+    }
+
     [HttpPost]
     [Route("/forms")]
     public IActionResult PostForm([FromForm] MvcTodo todo)

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Integration/OpenApiDocumentIntegrationTests.cs

@@ -1,41 +1,42 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
-using System.Globalization;
 using Microsoft.AspNetCore.InternalTesting;
 using Microsoft.AspNetCore.OpenApi;
 using Microsoft.Extensions.DependencyInjection;
-using Microsoft.OpenApi.Models;
-using Microsoft.OpenApi.Writers;
+using Microsoft.OpenApi;
+using Microsoft.OpenApi.Extensions;
 
 [UsesVerify]
 public sealed class OpenApiDocumentIntegrationTests(SampleAppFixture fixture) : IClassFixture<SampleAppFixture>
 {
     [Theory]
-    [InlineData("v1")]
-    [InlineData("v2")]
-    [InlineData("controllers")]
-    [InlineData("responses")]
-    [InlineData("forms")]
-    [InlineData("schemas-by-ref")]
-    [InlineData("xml")]
-    public async Task VerifyOpenApiDocument(string documentName)
+    [InlineData("v1", OpenApiSpecVersion.OpenApi3_0)]
+    [InlineData("v2", OpenApiSpecVersion.OpenApi3_0)]
+    [InlineData("controllers", OpenApiSpecVersion.OpenApi3_0)]
+    [InlineData("responses", OpenApiSpecVersion.OpenApi3_0)]
+    [InlineData("forms", OpenApiSpecVersion.OpenApi3_0)]
+    [InlineData("schemas-by-ref", OpenApiSpecVersion.OpenApi3_0)]
+    [InlineData("xml", OpenApiSpecVersion.OpenApi3_0)]
+    [InlineData("v1", OpenApiSpecVersion.OpenApi3_1)]
+    [InlineData("v2", OpenApiSpecVersion.OpenApi3_1)]
+    [InlineData("controllers", OpenApiSpecVersion.OpenApi3_1)]
+    [InlineData("responses", OpenApiSpecVersion.OpenApi3_1)]
+    [InlineData("forms", OpenApiSpecVersion.OpenApi3_1)]
+    [InlineData("schemas-by-ref", OpenApiSpecVersion.OpenApi3_1)]
+    [InlineData("xml", OpenApiSpecVersion.OpenApi3_1)]
+    public async Task VerifyOpenApiDocument(string documentName, OpenApiSpecVersion version)
     {
         var documentService = fixture.Services.GetRequiredKeyedService<OpenApiDocumentService>(documentName);
         var scopedServiceProvider = fixture.Services.CreateScope();
         var document = await documentService.GetOpenApiDocumentAsync(scopedServiceProvider.ServiceProvider);
-        await Verifier.Verify(GetOpenApiJson(document))
-            .UseDirectory(SkipOnHelixAttribute.OnHelix()
-                ? Path.Combine(Environment.GetEnvironmentVariable("HELIX_WORKITEM_ROOT"), "Integration", "snapshots")
-                : "snapshots")
+        var json = await document.SerializeAsJsonAsync(version);
+        var baseSnapshotsDirectory = SkipOnHelixAttribute.OnHelix()
+            ? Path.Combine(Environment.GetEnvironmentVariable("HELIX_WORKITEM_ROOT"), "Integration", "snapshots")
+            : "snapshots";
+        var outputDirectory = Path.Combine(baseSnapshotsDirectory, version.ToString());
+        await Verifier.Verify(json)
+            .UseDirectory(outputDirectory)
             .UseParameters(documentName);
     }
-
-    private static string GetOpenApiJson(OpenApiDocument document)
-    {
-        using var textWriter = new StringWriter(CultureInfo.InvariantCulture);
-        var jsonWriter = new OpenApiJsonWriter(textWriter);
-        document.SerializeAsV31(jsonWriter);
-        return textWriter.ToString();
-    }
 }

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Integration/snapshots/OpenApi3_0/OpenApiDocumentIntegrationTests.VerifyOpenApiDocument_documentName=forms.verified.txt

@@ -198,19 +198,24 @@
         "properties": {
           "id": {
             "type": "integer",
+            "description": "The unique identifier of the to-do item.",
             "format": "int32"
           },
           "title": {
-            "type": "string"
+            "type": "string",
+            "description": "The title of the to-do item."
           },
           "completed": {
-            "type": "boolean"
+            "type": "boolean",
+            "description": "Indicates whether the to-do item is completed."
           },
           "createdAt": {
             "type": "string",
+            "description": "The date and time when the to-do item was created.",
             "format": "date-time"
           }
-        }
+        },
+        "description": "Represents a to-do item."
       }
     }
   },

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Integration/snapshots/OpenApi3_0/OpenApiDocumentIntegrationTests.VerifyOpenApiDocument_documentName=responses.verified.txt

@@ -163,19 +163,24 @@
         "properties": {
           "id": {
             "type": "integer",
+            "description": "The unique identifier of the to-do item.",
             "format": "int32"
           },
           "title": {
-            "type": "string"
+            "type": "string",
+            "description": "The title of the to-do item."
           },
           "completed": {
-            "type": "boolean"
+            "type": "boolean",
+            "description": "Indicates whether the to-do item is completed."
           },
           "createdAt": {
             "type": "string",
+            "description": "The date and time when the to-do item was created.",
             "format": "date-time"
           }
-        }
+        },
+        "description": "Represents a to-do item."
       },
       "Triangle": {
         "type": "object",

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.Tests/Integration/snapshots/OpenApi3_0/OpenApiDocumentIntegrationTests.VerifyOpenApiDocument_documentName=v1.verified.txt

@@ -136,19 +136,24 @@
         "properties": {
           "id": {
             "type": "integer",
+            "description": "The unique identifier of the to-do item.",
             "format": "int32"
           },
           "title": {
-            "type": "string"
+            "type": "string",
+            "description": "The title of the to-do item."
           },
           "completed": {
-            "type": "boolean"
+            "type": "boolean",
+            "description": "Indicates whether the to-do item is completed."
           },
           "createdAt": {
             "type": "string",
+            "description": "The date and time when the to-do item was created.",
             "format": "date-time"
           }
-        }
+        },
+        "description": "Represents a to-do item."
       },
       "TodoWithDueDate": {
         "required": [
@@ -162,23 +167,29 @@
         "properties": {
           "dueDate": {
             "type": "string",
+            "description": "The due date of the to-do item.",
             "format": "date-time"
           },
           "id": {
             "type": "integer",
+            "description": "The unique identifier of the to-do item.",
             "format": "int32"
           },
           "title": {
-            "type": "string"
+            "type": "string",
+            "description": "The title of the to-do item."
           },
           "completed": {
-            "type": "boolean"
+            "type": "boolean",
+            "description": "Indicates whether the to-do item is completed."
           },
           "createdAt": {
             "type": "string",
+            "description": "The date and time when the to-do item was created.",
             "format": "date-time"
           }
-        }
+        },
+        "description": "Represents a to-do item with a due date."
       }
     },
     "securitySchemes": {