Bump Microsoft.OpenApi from 2.3.9 to 3.0.0

.azure-pipelines/ci-build.yml

@@ -8,6 +8,7 @@ trigger:
     include:
       - main
       - support/v1
+      - support/v2
   tags:
     include:
       - 'v*'
@@ -16,6 +17,7 @@ pr:
     include:
       - main
       - support/v1
+      - support/v2
 
 variables:
   buildPlatform: 'Any CPU'

.github/policies/OpenAPI.NET.OData-branch-protection.yml

@@ -49,6 +49,42 @@ configuration:
     # This branch pattern applies to the following branches as of 06/09/2024 20:45:44:
     # support/v1
 
+    # Specifies whether this branch can be deleted. boolean
+    allowsDeletions: false
+    # Specifies whether forced pushes are allowed on this branch. boolean
+    allowsForcePushes: false
+    # Specifies whether new commits pushed to the matching branches dismiss pull request review approvals. boolean
+    dismissStaleReviews: true
+    # Specifies whether admins can overwrite branch protection. boolean
+    isAdminEnforced: false
+    # Indicates whether "Require a pull request before merging" is enabled. boolean
+    requiresPullRequestBeforeMerging: true
+    # Specifies the number of pull request reviews before merging. int (0-6). Should be null/empty if PRs are not required
+    requiredApprovingReviewsCount: 1
+    # Require review from Code Owners. Requires requiredApprovingReviewsCount. boolean
+    requireCodeOwnersReview: true
+    # Are commits required to be signed. boolean. TODO: all contributors must have commit signing on local machines.
+    requiresCommitSignatures: false
+    # Are conversations required to be resolved before merging? boolean
+    requiresConversationResolution: true
+    # Are merge commits prohibited from being pushed to this branch. boolean
+    requiresLinearHistory: false
+    # Required status checks to pass before merging. Values can be any string, but if the value does not correspond to any existing status check, the status check will be stuck on pending for status since nothing exists to push an actual status
+    requiredStatusChecks:
+    - license/cla
+    - Continuous Integration
+    - CodeQL
+    # Require branches to be up to date before merging. This should be false since the repo contains autogenerated files. boolean
+    requiresStrictStatusChecks: false
+    # Indicates whether there are restrictions on who can push. boolean. Should be set with whoCanPush.
+    restrictsPushes: false
+    # Restrict who can dismiss pull request reviews. boolean
+    restrictsReviewDismissals: false
+
+  - branchNamePattern: support/v2
+    # This branch pattern applies to the following branches as of 06/09/2024 20:45:44:
+    # support/v1
+
     # Specifies whether this branch can be deleted. boolean
     allowsDeletions: false
     # Specifies whether forced pushes are allowed on this branch. boolean

.github/release-please.yml

@@ -3,5 +3,8 @@ primaryBranch: main
 handleGHRelease: true
 branches:
   - branch: support/v1
+    manifest: true
+    handleGHRelease: true
+  - branch: support/v2
     manifest: true
     handleGHRelease: true

.github/workflows/codeql-analysis.yml

@@ -13,10 +13,10 @@ name: "CodeQL"
 
 on:
   push:
-    branches: [ main, support/v1 ]
+    branches: [ main, support/v1, support/v2 ]
   pull_request:
     # The branches below must be a subset of the branches above
-    branches: [ main, support/v1 ]
+    branches: [ main, support/v1, support/v2 ]
   schedule:
     - cron: '32 2 * * 6'
   workflow_dispatch:

.github/workflows/release-please-gha.yml

@@ -15,6 +15,7 @@ on:
     branches:
       - main
       - support/v1
+      - support/v2
 
 permissions:
   contents: read

.github/workflows/sonarcloud.yml

@@ -5,6 +5,7 @@ on:
     branches:
       - main
       - support/v1
+      - support/v2
     paths-ignore: ['.vscode/**']
   pull_request:
     types: [opened, synchronize, reopened]

.github/workflows/validate-descriptions.yml

@@ -2,9 +2,9 @@ name: OpenAPI Parser Validation for latest OpenAPI docs
 
 on:
   push:
-    branches: [ main, support/v1 ]
+    branches: [ main, support/v1, support/v2 ]
   pull_request:
-    branches: [ main, support/v1 ]
+    branches: [ main, support/v1, support/v2 ]
 
 jobs:
 

src/Microsoft.OpenApi.OData.Reader/Common/OpenApiOperationExtensions.cs

@@ -43,7 +43,7 @@ public static void AddErrorResponses(this OpenApiOperation operation, OpenApiCon
                     response = new()
                     {
                         Description = Constants.Success,
-                        Content = new Dictionary<string, OpenApiMediaType>
+                        Content = new Dictionary<string, IOpenApiMediaType>
                         {
                             {
                                 Constants.ApplicationJsonMediaType,

src/Microsoft.OpenApi.OData.Reader/Generator/OpenApiParameterGenerator.cs

@@ -94,7 +94,7 @@ public static IList<IOpenApiParameter> CreateParameters(this ODataContext contex
                         Required = true,
 
                         // Create schema in the Content property to indicate that the parameters are serialized as JSON
-                        Content = new Dictionary<string, OpenApiMediaType>
+                        Content = new Dictionary<string, IOpenApiMediaType>
                         {
                             {
                                 Constants.ApplicationJsonMediaType,

src/Microsoft.OpenApi.OData.Reader/Generator/OpenApiRequestBodyGenerator.cs

@@ -78,7 +78,7 @@ internal static class OpenApiRequestBodyGenerator
             {
                 Description = "Action parameters",
                 Required = true,
-                Content = new Dictionary<string, OpenApiMediaType>()
+                Content = new Dictionary<string, IOpenApiMediaType>()
             };
 
             requestBody.Content.Add(Constants.ApplicationJsonMediaType, new OpenApiMediaType
@@ -123,7 +123,7 @@ private static OpenApiRequestBody CreateRefPostRequestBody(OpenApiDocument docum
             {
                 Required = true,
                 Description = "New navigation property ref value",
-                Content = new Dictionary<string, OpenApiMediaType>
+                Content = new Dictionary<string, IOpenApiMediaType>
                 {
                     {
                         Constants.ApplicationJsonMediaType, new OpenApiMediaType
@@ -148,7 +148,7 @@ private static OpenApiRequestBody CreateRefPutRequestBody(OpenApiDocument docume
             {
                 Required = true,
                 Description = "New navigation property ref values",
-                Content = new Dictionary<string, OpenApiMediaType>
+                Content = new Dictionary<string, IOpenApiMediaType>
                 {
                     {
                         Constants.ApplicationJsonMediaType, new OpenApiMediaType

src/Microsoft.OpenApi.OData.Reader/Generator/OpenApiResponseGenerator.cs

@@ -117,7 +117,7 @@
 
             OpenApiResponses responses = new();
 
             if (operation.IsAction() && operation.ReturnType == null && Constants.StatusCode204.GetResponse(document) is {} x204Response)
             {
                 responses.Add(Constants.StatusCode204, x204Response);
             }
@@ -150,11 +150,11 @@
 
         public static OpenApiResponse? CreateOperationResponse(this ODataContext context, IEdmOperation operation, OpenApiDocument document)
         {
             if (operation.ReturnType == null)
                 return null;
 
             IOpenApiSchema schema;
             if (operation.ReturnType.IsCollection())
             {
                 OpenApiSchema baseSchema = new()
                 {
@@ -162,7 +162,7 @@
                     Properties = new Dictionary<string, IOpenApiSchema>
                     {
                         {
                             "value", context.CreateEdmTypeSchema(operation.ReturnType, document)
                         }
                     }
                 };
@@ -202,12 +202,12 @@
 
                 if (schema is OpenApiSchema openApiSchema)
                 {
                     openApiSchema.Title = operation.ReturnType.Definition.AsElementType() is not IEdmEntityType entityType
                             ? null : $"Collection of {entityType.Name}";
                     openApiSchema.Type = JsonSchemaType.Object;
                 }
             }
             else if (operation.ReturnType.IsPrimitive())
             {
                 // A property or operation response that is of a primitive type is represented as an object with a single name/value pair,
                 // whose name is value and whose value is a primitive value.
@@ -217,14 +217,14 @@
                     Properties = new Dictionary<string, IOpenApiSchema>
                     {
                         {
                             "value", context.CreateEdmTypeSchema(operation.ReturnType, document)
                         }
                     }
                 };
             }
             else
             {
                 schema = context.CreateEdmTypeSchema(operation.ReturnType, document);
             }
 
             string? mediaType = Constants.ApplicationJsonMediaType;
@@ -242,7 +242,7 @@
             OpenApiResponse response = new()
             {
                 Description = "Success",
-                Content = new Dictionary<string, OpenApiMediaType>
+                Content = new Dictionary<string, IOpenApiMediaType>
                 {
                     {
                         mediaType,
@@ -267,7 +267,7 @@
             return new OpenApiResponse
             {
                 Description = "Retrieved collection",
-                Content = new Dictionary<string, OpenApiMediaType>
+                Content = new Dictionary<string, IOpenApiMediaType>
                 {
                     {
                         Constants.ApplicationJsonMediaType,
@@ -286,7 +286,7 @@
             return new OpenApiResponse
             {
                 Description = "The count of the resource",
-                Content = new Dictionary<string, OpenApiMediaType>
+                Content = new Dictionary<string, IOpenApiMediaType>
                 {
                     {
                         "text/plain",
@@ -305,7 +305,7 @@
             return new OpenApiResponse
             {
                 Description = "error",
-                Content = new Dictionary<string, OpenApiMediaType>
+                Content = new Dictionary<string, IOpenApiMediaType>
                 {
                     {
                         Constants.ApplicationJsonMediaType,

src/Microsoft.OpenApi.OData.Reader/Microsoft.OpenAPI.OData.Reader.csproj

@@ -30,7 +30,7 @@
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
     <PackageReference Include="Microsoft.OData.Edm" Version="8.4.2" />
-    <PackageReference Include="Microsoft.OpenApi" Version="2.3.9" />
+    <PackageReference Include="Microsoft.OpenApi" Version="3.0.0" />
     <None Include="..\..\README.md" Pack="true" PackagePath="\" />
     <PackageReference Include="Microsoft.VisualStudio.Threading.Analyzers" Version="17.14.15">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>

src/Microsoft.OpenApi.OData.Reader/Operation/ComplexPropertyPostOperationHandler.cs

@@ -89,7 +89,7 @@ protected override void SetRequestBody(OpenApiOperation operation)
         {
             Required = true,
             Description = "New property values",
-            Content = new Dictionary<string, OpenApiMediaType>
+            Content = new Dictionary<string, IOpenApiMediaType>
             {
                 {
                     Constants.ApplicationJsonMediaType, new OpenApiMediaType

src/Microsoft.OpenApi.OData.Reader/Operation/ComplexPropertyUpdateOperationHandler.cs

@@ -65,7 +65,7 @@ protected override void SetRequestBody(OpenApiOperation operation)
         {
             Required = true,
             Description = "New property values",
-            Content = new Dictionary<string, OpenApiMediaType>
+            Content = new Dictionary<string, IOpenApiMediaType>
             {
                 {
                     Constants.ApplicationJsonMediaType, new OpenApiMediaType

src/Microsoft.OpenApi.OData.Reader/Operation/EntityGetOperationHandler.cs

@@ -128,7 +128,7 @@ protected override void SetResponses(OpenApiOperation operation)
                     new OpenApiResponse
                     {
                         Description = "Retrieved entity",
-                        Content = new Dictionary<string, OpenApiMediaType>
+                        Content = new Dictionary<string, IOpenApiMediaType>
                         {
                             {
                                 Constants.ApplicationJsonMediaType,

src/Microsoft.OpenApi.OData.Reader/Operation/EntitySetPostOperationHandler.cs

@@ -133,10 +133,10 @@ protected override void AppendCustomParameters(OpenApiOperation operation)
         /// Get the entity content description.
         /// </summary>
         /// <returns>The entity content description.</returns>
-        private Dictionary<string, OpenApiMediaType> GetContentDescription()
+        private Dictionary<string, IOpenApiMediaType> GetContentDescription()
         {
             var schema = GetEntitySchema();
-            var content = new Dictionary<string, OpenApiMediaType>();
+            var content = new Dictionary<string, IOpenApiMediaType>();
 
             if (EntitySet is {EntityType.HasStream: true})
             {
@@ -145,7 +145,7 @@ private Dictionary<string, OpenApiMediaType> GetContentDescription()
                 {
                     foreach (string item in mediaTypes)
                     {
-                        content.Add(item, new());
+                        content.Add(item, new OpenApiMediaType());
                     }
                 }
                 else

src/Microsoft.OpenApi.OData.Reader/Operation/EntityUpdateOperationHandler.cs

@@ -85,10 +85,10 @@ protected override void SetRequestBody(OpenApiOperation operation)
             base.SetRequestBody(operation);
         }
 
-        protected Dictionary<string, OpenApiMediaType> GetContent()
+        protected Dictionary<string, IOpenApiMediaType> GetContent()
         {
             var schema = GetOpenApiSchema();
-            var content = new Dictionary<string, OpenApiMediaType>();
+            var content = new Dictionary<string, IOpenApiMediaType>();
 
             // Add the annotated request content media types
             if (_updateRestrictions?.RequestContentTypes is {} mediaTypes)

src/Microsoft.OpenApi.OData.Reader/Operation/MediaEntityOperationalHandler.cs

@@ -163,7 +163,7 @@ protected string GetOperationId(string prefix, string identifier)
         /// Gets a media entity content description.
         /// </summary>
         /// <returns>The entity content description.</returns>
-        protected Dictionary<string, OpenApiMediaType> GetContentDescription()
+        protected Dictionary<string, IOpenApiMediaType> GetContentDescription()
         {
             // Fetch the respective AcceptableMediaTypes
             (_, var property) = GetStreamElements();
@@ -174,7 +174,7 @@ protected Dictionary<string, OpenApiMediaType> GetContentDescription()
                 Format = "binary"
             };
 
-            var content = new Dictionary<string, OpenApiMediaType>();
+            var content = new Dictionary<string, IOpenApiMediaType>();
             if (property is not null &&
                 Context?.Model.GetCollection(property,
                     CoreConstants.AcceptableMediaTypes) is {} mediaTypes)

src/Microsoft.OpenApi.OData.Reader/Operation/MetadataGetOperationHandler.cs

@@ -63,7 +63,7 @@ protected override void SetResponses(OpenApiOperation operation)
                     new OpenApiResponse
                     {
                         Description = "Retrieved metadata document",
-                        Content = new Dictionary<string, OpenApiMediaType>
+                        Content = new Dictionary<string, IOpenApiMediaType>
                         {
                             {
                                 Constants.ApplicationXmlMediaType,

src/Microsoft.OpenApi.OData.Reader/Operation/NavigationPropertyGetOperationHandler.cs

@@ -126,7 +126,7 @@ protected override void SetResponses(OpenApiOperation operation)
                         new OpenApiResponse
                         {
                             Description = "Retrieved navigation property",
-                            Content = new Dictionary<string, OpenApiMediaType>
+                            Content = new Dictionary<string, IOpenApiMediaType>
                             {
                                 {
                                     Constants.ApplicationJsonMediaType,

src/Microsoft.OpenApi.OData.Reader/Operation/NavigationPropertyOperationHandler.cs

@@ -205,10 +205,10 @@ protected override void SetExternalDocs(OpenApiOperation operation)
             }
         }
 
-        protected Dictionary<string, OpenApiMediaType> GetContent(IOpenApiSchema? schema = null, IEnumerable<string>? mediaTypes = null)
+        protected Dictionary<string, IOpenApiMediaType> GetContent(IOpenApiSchema? schema = null, IEnumerable<string>? mediaTypes = null)
         {
             schema ??= GetOpenApiSchema();
-            var content = new Dictionary<string, OpenApiMediaType>();
+            var content = new Dictionary<string, IOpenApiMediaType>();
 
             if (mediaTypes != null)
             {

src/Microsoft.OpenApi.OData.Reader/Operation/OperationHandler.cs

@@ -341,7 +341,7 @@ internal void SetSingleResponse(OpenApiOperation operation, IOpenApiSchema schem
                     new OpenApiResponse
                     {
                         Description = "Entity result.",
-                        Content = new Dictionary<string, OpenApiMediaType>
+                        Content = new Dictionary<string, IOpenApiMediaType>
                         {
                             {
                                 Constants.ApplicationJsonMediaType,

src/Microsoft.OpenApi.OData.Reader/Operation/RefGetOperationHandler.cs

@@ -115,7 +115,7 @@ protected override void SetResponses(OpenApiOperation operation)
                         new OpenApiResponse
                         {
                             Description = "Retrieved navigation property link",
-                            Content = new Dictionary<string, OpenApiMediaType>
+                            Content = new Dictionary<string, IOpenApiMediaType>
                             {
                                 {
                                     Constants.ApplicationJsonMediaType,

src/Microsoft.OpenApi.OData.Reader/Operation/SingletonGetOperationHandler.cs

@@ -116,7 +116,7 @@ protected override void SetResponses(OpenApiOperation operation)
                         new OpenApiResponse
                         {
                             Description = "Retrieved entity",
-                            Content = new Dictionary<string, OpenApiMediaType>
+                            Content = new Dictionary<string, IOpenApiMediaType>
                             {
                                 {
                                     Constants.ApplicationJsonMediaType,

src/Microsoft.OpenApi.OData.Reader/Operation/SingletonPatchOperationHandler.cs

@@ -72,7 +72,7 @@ protected override void SetRequestBody(OpenApiOperation operation)
             {
                 Required = true,
                 Description = "New property values",
-                Content = new Dictionary<string, OpenApiMediaType>
+                Content = new Dictionary<string, IOpenApiMediaType>
                 {
                     {
                         Constants.ApplicationJsonMediaType, new OpenApiMediaType

test/Microsoft.OpenAPI.OData.Reader.Tests/Generator/OpenApiResponseGeneratorTests.cs

@@ -215,7 +215,7 @@ public void CreateResponseForEdmFunctionReturnCorrectResponses(bool isFunctionIm
 
             var response = responses["200"];
             Assert.NotNull(response.Content);
-            OpenApiMediaType mediaType = response.Content["application/json"];
+            OpenApiMediaType mediaType = Assert.IsType<OpenApiMediaType>(response.Content["application/json"]);
 // openApi version 2 should not use AnyOf
             if (specVersion == OpenApiSpecVersion.OpenApi2_0)
             {

test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Basic.OpenApi.V3.1.json

@@ -1,5 +1,5 @@
 {
-  "openapi": "3.1.1",
+  "openapi": "3.1.2",
   "info": {
     "title": "OData Service for namespace DefaultNs",
     "description": "This OData service is located at http://localhost",

test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Basic.OpenApi.V3.1.yaml

@@ -1,4 +1,4 @@
-openapi: '3.1.1'
+openapi: '3.1.2'
 info:
   title: OData Service for namespace DefaultNs
   description: This OData service is located at http://localhost

test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Empty.OpenApi.V3.1.json

@@ -1,5 +1,5 @@
 {
-  "openapi": "3.1.1",
+  "openapi": "3.1.2",
   "info": {
     "title": "OData Service for namespace ",
     "description": "This OData service is located at http://localhost",

test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Empty.OpenApi.V3.1.yaml

@@ -1,4 +1,4 @@
-openapi: '3.1.1'
+openapi: '3.1.2'
 info:
   title: 'OData Service for namespace '
   description: This OData service is located at http://localhost

test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Multiple.Schema.OpenApi.V3.1.json

@@ -1,5 +1,5 @@
 {
-  "openapi": "3.1.1",
+  "openapi": "3.1.2",
   "info": {
     "title": "OData Service for namespace Default",
     "description": "This OData service is located at http://localhost",

test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Multiple.Schema.OpenApi.V3.1.yaml

@@ -1,4 +1,4 @@
-openapi: '3.1.1'
+openapi: '3.1.2'
 info:
   title: OData Service for namespace Default
   description: This OData service is located at http://localhost