Update Microsoft.OpenApi to preview28 #62363

captainsafia · 2025-06-16T22:19:44Z

This pull request primarily updates the Microsoft.OpenApi package versions and refactors code to simplify imports and improve type usage. The most significant changes include updating dependencies, replacing outdated Microsoft.OpenApi.Models types with the new Microsoft.OpenApi namespace, and modifying public API definitions accordingly.

Dependency Updates:

Updated MicrosoftOpenApiVersion and MicrosoftOpenApiYamlReaderVersion from 2.0.0-preview.18 to 2.0.0-preview.28 in eng/Versions.props.

Refactoring Imports:

Removed references to Microsoft.OpenApi.Models, Microsoft.OpenApi.Models.Interfaces, and Microsoft.OpenApi.Models.References in favor of the new Microsoft.OpenApi namespace across multiple files, including XmlCommentGenerator.Emitter.cs, TransformersBenchmark.cs, and various transformer files in the sample directory. [1] [2] [3] [4] [5] [6] [7]

Code Adjustments:

Replaced the initialization of schema.Extensions from an empty array ([]) to a Dictionary<string, IOpenApiExtension> in TransformersBenchmark.cs. [1] [2]

Public API Updates:

Updated public API definitions in PublicAPI.Shipped.txt to reflect the transition from Microsoft.OpenApi.Models types to Microsoft.OpenApi types. This includes changes to method signatures and transformer interfaces. [1] [2] [3]

Project Configuration:

Added <Using Include="Microsoft.OpenApi" /> to the Sample.csproj and Microsoft.AspNetCore.OpenApi.csproj files to simplify namespace management. [1] [2]

BrennanConroy · 2025-06-16T23:16:49Z

src/OpenApi/src/PublicAPI.Shipped.txt

@@ -2,11 +2,11 @@
 Microsoft.AspNetCore.Builder.OpenApiEndpointConventionBuilderExtensions
 Microsoft.AspNetCore.Builder.OpenApiEndpointRouteBuilderExtensions
 Microsoft.AspNetCore.OpenApi.IOpenApiDocumentTransformer
-Microsoft.AspNetCore.OpenApi.IOpenApiDocumentTransformer.TransformAsync(Microsoft.OpenApi.Models.OpenApiDocument! document, Microsoft.AspNetCore.OpenApi.OpenApiDocumentTransformerContext! context, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task!


Don't touch this file

The codefixer for the PublicAPI analyzer applied this delta. Although I think it just reveals an underlying bug in the way the PublicAPI analyzer works? In this case, the same types for existing APIs have been moved to new namespaces. Maybe the delta here is to remove all the old APIs and then add the new ones?

src/OpenApi/perf/Microbenchmarks/TransformersBenchmark.cs

BrennanConroy

Breaking change announcement probably needed for API changing?

BrennanConroy · 2025-06-16T23:20:33Z

src/OpenApi/test/Microsoft.AspNetCore.OpenApi.SourceGenerators.Tests/SnapshotTestHelper.cs

@@ -98,7 +97,8 @@ public static Task Verify(string source, IIncrementalGenerator generator, Dictio
            .ScrubLinesWithReplace(line => InterceptsLocationRegex().Replace(line, "[InterceptsLocation]"))
            .UseDirectory(SkipOnHelixAttribute.OnHelix()
                ? Path.Combine(Environment.GetEnvironmentVariable("HELIX_WORKITEM_ROOT"), "snapshots")
-                : "snapshots");
+                : "snapshots")
+            .AutoVerify();


BrennanConroy · 2025-06-16T23:20:45Z

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

@@ -38,6 +36,7 @@ public async Task VerifyOpenApiDocument(string documentName, OpenApiSpecVersion
        var outputDirectory = Path.Combine(baseSnapshotsDirectory, version.ToString());
        await Verifier.Verify(json)
            .UseDirectory(outputDirectory)
-            .UseParameters(documentName);
+            .UseParameters(documentName)
+            .AutoVerify();


BrennanConroy · 2025-06-17T16:53:14Z

src/OpenApi/src/Services/OpenApiDocumentProvider.cs

-using Microsoft.OpenApi;
-using Microsoft.OpenApi.Extensions;
-using Microsoft.OpenApi.Writers;
+


BrennanConroy · 2025-06-17T17:05:43Z

src/OpenApi/src/Services/Schemas/OpenApiSchemaService.cs

@@ -140,10 +137,11 @@ internal async Task<OpenApiSchema> GetOrCreateUnresolvedSchemaAsync(OpenApiDocum
    internal async Task<IOpenApiSchema> GetOrCreateSchemaAsync(OpenApiDocument document, Type type, IServiceProvider scopedServiceProvider, IOpenApiSchemaTransformer[] schemaTransformers, ApiParameterDescription? parameterDescription = null, CancellationToken cancellationToken = default)
    {
        var schema = await GetOrCreateUnresolvedSchemaAsync(document, type, scopedServiceProvider, schemaTransformers, parameterDescription, cancellationToken);
-        return ResolveReferenceForSchema(document, schema);
+        var baseSchemaId = optionsMonitor.Get(documentName).CreateSchemaReferenceId(_jsonSerializerOptions.GetTypeInfo(type));


Is this expensive? Do we care?

BrennanConroy · 2025-06-17T17:08:34Z

...NetCore.OpenApi.Tests/Transformers/Implementations/OpenApiSchemaReferenceTransformerTests.cs

@@ -712,18 +708,15 @@ await VerifyOpenApiDocument(builder, document =>

            // Assert items are arrays of strings
            Assert.Equal(JsonSchemaType.Array, seq1Schema.Items.Type);
-            // Todo: See https://github.com/microsoft/OpenAPI.NET/issues/2062
-            // Assert.Equal(JsonSchemaType.Array, seq2Schema.Items.Type);
+            Assert.Equal(JsonSchemaType.Array, seq2Schema.Items.Type);


BrennanConroy · 2025-06-17T17:11:14Z

src/OpenApi/src/Services/Schemas/OpenApiSchemaService.cs

+            {
+                return document.AddOpenApiSchemaByReference(schemaIdString, schema);
+            }
+            var relativeSchemaId = $"#/components/schemas/{rootSchemaId}{refIdString.Replace("#", string.Empty)}";


Is this where the tags and items updates in the tests comes from?

Do we want to add any explicit testing here?

martincostello · 2025-06-17T17:24:02Z

Breaking change announcement probably needed for API changing?

Comparing main vs this PR, there's already a tonne of breaking changes via Microsoft.OpenApi in already shipped previews of 10. This is just even more churn on top of what we've had already 😅.

captainsafia added 2 commits June 13, 2025 11:57

Update Microsoft.OpenApi to preview22

c5c5329

Bump to preview28

84e5687

captainsafia requested review from tdykstra, a team and wtgodbe as code owners June 16, 2025 22:19

github-actions bot added the needs-area-label Used by the dotnet-issue-labeler to label those issues which couldn't be triaged automatically label Jun 16, 2025

build-analysis bot mentioned this pull request Jun 16, 2025

Known Build Error: error : Cannot create a file when that file already exists. #61178

Open

BrennanConroy reviewed Jun 16, 2025

View reviewed changes

src/OpenApi/perf/Microbenchmarks/TransformersBenchmark.cs Show resolved Hide resolved

Fix PublicAPI files and Tools directory

f4ec475

BrennanConroy approved these changes Jun 17, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Update Microsoft.OpenApi to preview28 #62363

Update Microsoft.OpenApi to preview28 #62363

captainsafia commented Jun 16, 2025

Uh oh!

BrennanConroy Jun 16, 2025

Uh oh!

captainsafia Jun 17, 2025

Uh oh!

Uh oh!

BrennanConroy left a comment

Uh oh!

BrennanConroy Jun 16, 2025

Uh oh!

BrennanConroy Jun 16, 2025

Uh oh!

BrennanConroy Jun 17, 2025

Uh oh!

BrennanConroy Jun 17, 2025

Uh oh!

BrennanConroy Jun 17, 2025

Uh oh!

BrennanConroy Jun 17, 2025

Uh oh!

martincostello commented Jun 17, 2025

Uh oh!

Uh oh!

Update Microsoft.OpenApi to preview28 #62363

Are you sure you want to change the base?

Update Microsoft.OpenApi to preview28 #62363

Conversation

captainsafia commented Jun 16, 2025

Dependency Updates:

Refactoring Imports:

Code Adjustments:

Public API Updates:

Project Configuration:

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

BrennanConroy left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

martincostello commented Jun 17, 2025

Uh oh!

Uh oh!