chore: upgrades from using obsolete APIs

baywet · baywet · commit b888063a50fc · 2026-01-06T14:34:53.000-05:00
diff --git a/src/Microsoft.OpenApi.OData.Reader/Edm/ODataPathProvider.cs b/src/Microsoft.OpenApi.OData.Reader/Edm/ODataPathProvider.cs
@@ -872,16 +872,16 @@ private void RetrieveBoundOperationPaths(OpenApiConvertSettings convertSettings)
             var functionPaths = _allOperationPaths.Where(x => x.LastSegment is ODataOperationSegment operationSegment
                                                     && operationSegment.Operation is IEdmFunction edmFunction
                                                     && edmFunction.IsComposable
-                                                    && edmFunction.ReturnType != null
-                                                    && edmFunction.ReturnType.Definition is IEdmEntityType);
+                                                    && edmFunction.GetReturn()?.Type is { } retType
+                                                    && retType.Definition is IEdmEntityType);
 
             foreach( var functionPath in functionPaths)
             {
                 if (functionPath.LastSegment is not ODataOperationSegment operationSegment
                                                     || operationSegment.Operation is not IEdmFunction edmFunction
                                                     || !edmFunction.IsComposable
-                                                    || edmFunction.ReturnType == null
-                                                    || edmFunction.ReturnType.Definition is not IEdmEntityType returnBindingEntityType)
+                                                    || edmFunction.GetReturn()?.Type is not { } retType
+                                                    || retType.Definition is not IEdmEntityType returnBindingEntityType)
                 {
                     continue;
                 }
@@ -1194,7 +1194,7 @@ private void AppendBoundOperationOnOperationPath(IEdmOperation edmOperation, boo
                 if (path.LastSegment is not ODataOperationSegment operationSegment 
                     || (path.Segments.Count > 1 && path.Segments[path.Segments.Count - 2] is ODataOperationSegment)
                     || operationSegment.Operation is not IEdmFunction edmFunction || !edmFunction.IsComposable
-                    || edmFunction.ReturnType == null || !edmFunction.ReturnType.Definition.Equals(bindingEntityType)
+                    || edmFunction.GetReturn()?.Type is not { } retType || !retType.Definition.Equals(bindingEntityType)
                     || isCollection
                     || _model is not null && !EdmModelHelper.IsOperationAllowed(_model, edmOperation, operationSegment.Operation, true))
                 {
diff --git a/src/Microsoft.OpenApi.OData.Reader/Generator/EdmSpatialTypeVisitor.cs b/src/Microsoft.OpenApi.OData.Reader/Generator/EdmSpatialTypeVisitor.cs
@@ -49,9 +49,9 @@ public void Visit(IEdmModel model)
 
         private void VisitOperation(IEdmOperation operation)
         {
-            if (operation.ReturnType != null)
+            if (operation.GetReturn() is {} operationReturn)
             {
-                this.VisitTypeReference(operation.ReturnType);
+                this.VisitTypeReference(operationReturn.Type);
             }
 
             foreach (var parameter in operation.Parameters)
diff --git a/src/Microsoft.OpenApi.OData.Reader/Generator/OpenApiResponseGenerator.cs b/src/Microsoft.OpenApi.OData.Reader/Generator/OpenApiResponseGenerator.cs
@@ -117,7 +117,7 @@ public static OpenApiResponses CreateResponses(this ODataContext context, IEdmOp
 
             OpenApiResponses responses = new();
             
-            if (operation.IsAction() && operation.ReturnType == null && Constants.StatusCode204.GetResponse(document) is {} x204Response)
+            if (operation.IsAction() && operation.GetReturn()?.Type == null && Constants.StatusCode204.GetResponse(document) is {} x204Response)
             {
                 responses.Add(Constants.StatusCode204, x204Response);
             }
@@ -150,19 +150,19 @@ public static OpenApiResponses CreateResponses(this ODataContext context, IEdmOp
 
         public static OpenApiResponse? CreateOperationResponse(this ODataContext context, IEdmOperation operation, OpenApiDocument document)
         {
-            if (operation.ReturnType == null)
+            if (operation.GetReturn()?.Type is not {} returnType)
                 return null;
 
             IOpenApiSchema schema;
-            if (operation.ReturnType.IsCollection())
+            if (returnType.IsCollection())
             {
                 OpenApiSchema baseSchema = new()
                 {
                     Type = JsonSchemaType.Object,
                     Properties = new Dictionary<string, IOpenApiSchema>
                     {
                         {
-                            "value", context.CreateEdmTypeSchema(operation.ReturnType, document)
+                            "value", context.CreateEdmTypeSchema(returnType, document)
                         }
                     }
                 };
@@ -202,12 +202,12 @@ public static OpenApiResponses CreateResponses(this ODataContext context, IEdmOp
 
                 if (schema is OpenApiSchema openApiSchema)
                 {
-                    openApiSchema.Title = operation.ReturnType.Definition.AsElementType() is not IEdmEntityType entityType
+                    openApiSchema.Title = returnType.Definition.AsElementType() is not IEdmEntityType entityType
                             ? null : $"Collection of {entityType.Name}";
                     openApiSchema.Type = JsonSchemaType.Object;
                 }
             }
-            else if (operation.ReturnType.IsPrimitive())
+            else if (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,18 +217,18 @@ public static OpenApiResponses CreateResponses(this ODataContext context, IEdmOp
                     Properties = new Dictionary<string, IOpenApiSchema>
                     {
                         {
-                            "value", context.CreateEdmTypeSchema(operation.ReturnType, document)
+                            "value", context.CreateEdmTypeSchema(returnType, document)
                         }
                     }
                 };
             }
             else
             {
-                schema = context.CreateEdmTypeSchema(operation.ReturnType, document);
+                schema = context.CreateEdmTypeSchema(returnType, document);
             }
 
             string? mediaType = Constants.ApplicationJsonMediaType;
-            if (operation.ReturnType.AsPrimitive()?.PrimitiveKind() == EdmPrimitiveTypeKind.Stream)
+            if (returnType.AsPrimitive()?.PrimitiveKind() == EdmPrimitiveTypeKind.Stream)
             {
                 mediaType = context.Model.GetString(operation, CoreConstants.MediaType);
 
diff --git a/src/Microsoft.OpenApi.OData.Reader/Operation/EdmOperationOperationHandler.cs b/src/Microsoft.OpenApi.OData.Reader/Operation/EdmOperationOperationHandler.cs
@@ -254,7 +254,7 @@ protected override void AppendCustomParameters(OpenApiOperation operation)
 
         private void AppendSystemQueryOptions(IEdmFunction function, OpenApiOperation operation)
         {
-            if (function.ReturnType.IsCollection() && Context is not null)
+            if (function.GetReturn()?.Type is {} functionReturnType && functionReturnType.IsCollection() && Context is not null)
             {
                 operation.Parameters ??= [];
                 // $top
@@ -287,7 +287,7 @@ private void AppendSystemQueryOptions(IEdmFunction function, OpenApiOperation op
                     operation.Parameters.AppendParameter(countParameter);
                 }
 
-                if (function.ReturnType?.Definition?.AsElementType() is IEdmEntityType entityType)
+                if (functionReturnType?.Definition?.AsElementType() is IEdmEntityType entityType)
                 {
                     // $select
                     if (Context.CreateSelect(function, entityType) is {} selectParameter)
@@ -347,7 +347,7 @@ protected override void SetExternalDocs(OpenApiOperation operation)
         // <inheritdoc/>
         protected override void SetExtensions(OpenApiOperation operation)
         {
-            if (Context is { Settings.EnablePagination: true } && EdmOperation?.ReturnType?.TypeKind() == EdmTypeKind.Collection)
+            if (Context is { Settings.EnablePagination: true } && EdmOperation?.GetReturn()?.Type?.TypeKind() == EdmTypeKind.Collection)
             {
                 var extension = new JsonObject
                 {
diff --git a/test/Microsoft.OpenAPI.OData.Reader.Tests/Operation/EdmActionOperationHandlerTests.cs b/test/Microsoft.OpenAPI.OData.Reader.Tests/Operation/EdmActionOperationHandlerTests.cs
@@ -342,7 +342,7 @@ public void CreateOperationForEdmActionWithCollectionReturnTypeContainsXMsPageab
             var operation = _operationHandler.CreateOperation(context, path);
 
             // Assert
-            if (enablePagination && action.ReturnType.IsCollection())
+            if (enablePagination && action.GetReturn()?.Type?.IsCollection() == true)
             {
               Assert.True(operation.Extensions.ContainsKey(Common.Constants.xMsPageable));
             }
diff --git a/test/Microsoft.OpenAPI.OData.Reader.Tests/Operation/EdmFunctionOperationHandlerTests.cs b/test/Microsoft.OpenAPI.OData.Reader.Tests/Operation/EdmFunctionOperationHandlerTests.cs
@@ -546,7 +546,7 @@ public void CreateOperationForEdmFunctionWithCollectionReturnTypeContainsXMsPage
             var operation = _operationHandler.CreateOperation(context, path);
 
             // Assert
-            if (enablePagination && function.ReturnType.IsCollection())
+            if (enablePagination && function.GetReturn()?.Type?.IsCollection() == true)
             {
               Assert.True(operation.Extensions.ContainsKey(Common.Constants.xMsPageable));
             }

Original file line number	Diff line number	Diff line change
`@@ -49,9 +49,9 @@ public void Visit(IEdmModel model)`
`49`	`49`
`50`	`50`	`private void VisitOperation(IEdmOperation operation)`
`51`	`51`	`{`
`52`		`- if (operation.ReturnType != null)`
	`52`	`+ if (operation.GetReturn() is {} operationReturn)`
`53`	`53`	`{`
`54`		`- this.VisitTypeReference(operation.ReturnType);`
	`54`	`+ this.VisitTypeReference(operationReturn.Type);`
`55`	`55`	`}`
`56`	`56`
`57`	`57`	`foreach (var parameter in operation.Parameters)`
Original file line number	Diff line number	Diff line change
`@@ -117,7 +117,7 @@ public static OpenApiResponses CreateResponses(this ODataContext context, IEdmOp`
`117`	`117`
`118`	`118`	`OpenApiResponses responses = new();`
`119`	`119`
`120`		`- if (operation.IsAction() && operation.ReturnType == null && Constants.StatusCode204.GetResponse(document) is {} x204Response)`
	`120`	`+ if (operation.IsAction() && operation.GetReturn()?.Type == null && Constants.StatusCode204.GetResponse(document) is {} x204Response)`
`121`	`121`	`{`
`122`	`122`	`responses.Add(Constants.StatusCode204, x204Response);`
`123`	`123`	`}`
`@@ -150,19 +150,19 @@ public static OpenApiResponses CreateResponses(this ODataContext context, IEdmOp`
`150`	`150`
`151`	`151`	`public static OpenApiResponse? CreateOperationResponse(this ODataContext context, IEdmOperation operation, OpenApiDocument document)`
`152`	`152`	`{`
`153`		`- if (operation.ReturnType == null)`
	`153`	`+ if (operation.GetReturn()?.Type is not {} returnType)`
`154`	`154`	`return null;`
`155`	`155`
`156`	`156`	`IOpenApiSchema schema;`
`157`		`- if (operation.ReturnType.IsCollection())`
	`157`	`+ if (returnType.IsCollection())`
`158`	`158`	`{`
`159`	`159`	`OpenApiSchema baseSchema = new()`
`160`	`160`	`{`
`161`	`161`	`Type = JsonSchemaType.Object,`
`162`	`162`	`Properties = new Dictionary<string, IOpenApiSchema>`
`163`	`163`	`{`
`164`	`164`	`{`
`165`		`- "value", context.CreateEdmTypeSchema(operation.ReturnType, document)`
	`165`	`+ "value", context.CreateEdmTypeSchema(returnType, document)`
`166`	`166`	`}`
`167`	`167`	`}`
`168`	`168`	`};`
`@@ -202,12 +202,12 @@ public static OpenApiResponses CreateResponses(this ODataContext context, IEdmOp`
`202`	`202`
`203`	`203`	`if (schema is OpenApiSchema openApiSchema)`
`204`	`204`	`{`
`205`		`- openApiSchema.Title = operation.ReturnType.Definition.AsElementType() is not IEdmEntityType entityType`
	`205`	`+ openApiSchema.Title = returnType.Definition.AsElementType() is not IEdmEntityType entityType`
`206`	`206`	`? null : $"Collection of {entityType.Name}";`
`207`	`207`	`openApiSchema.Type = JsonSchemaType.Object;`
`208`	`208`	`}`
`209`	`209`	`}`
`210`		`- else if (operation.ReturnType.IsPrimitive())`
	`210`	`+ else if (returnType.IsPrimitive())`
`211`	`211`	`{`
`212`	`212`	`// A property or operation response that is of a primitive type is represented as an object with a single name/value pair,`
`213`	`213`	`// whose name is value and whose value is a primitive value.`
`@@ -217,18 +217,18 @@ public static OpenApiResponses CreateResponses(this ODataContext context, IEdmOp`
`217`	`217`	`Properties = new Dictionary<string, IOpenApiSchema>`
`218`	`218`	`{`
`219`	`219`	`{`
`220`		`- "value", context.CreateEdmTypeSchema(operation.ReturnType, document)`
	`220`	`+ "value", context.CreateEdmTypeSchema(returnType, document)`
`221`	`221`	`}`
`222`	`222`	`}`
`223`	`223`	`};`
`224`	`224`	`}`
`225`	`225`	`else`
`226`	`226`	`{`
`227`		`- schema = context.CreateEdmTypeSchema(operation.ReturnType, document);`
	`227`	`+ schema = context.CreateEdmTypeSchema(returnType, document);`
`228`	`228`	`}`
`229`	`229`
`230`	`230`	`string? mediaType = Constants.ApplicationJsonMediaType;`
`231`		`- if (operation.ReturnType.AsPrimitive()?.PrimitiveKind() == EdmPrimitiveTypeKind.Stream)`
	`231`	`+ if (returnType.AsPrimitive()?.PrimitiveKind() == EdmPrimitiveTypeKind.Stream)`
`232`	`232`	`{`
`233`	`233`	`mediaType = context.Model.GetString(operation, CoreConstants.MediaType);`
`234`	`234`
Original file line number	Diff line number	Diff line change
`@@ -254,7 +254,7 @@ protected override void AppendCustomParameters(OpenApiOperation operation)`
`254`	`254`
`255`	`255`	`private void AppendSystemQueryOptions(IEdmFunction function, OpenApiOperation operation)`
`256`	`256`	`{`
`257`		`- if (function.ReturnType.IsCollection() && Context is not null)`
	`257`	`+ if (function.GetReturn()?.Type is {} functionReturnType && functionReturnType.IsCollection() && Context is not null)`
`258`	`258`	`{`
`259`	`259`	`operation.Parameters ??= [];`
`260`	`260`	`// $top`
`@@ -287,7 +287,7 @@ private void AppendSystemQueryOptions(IEdmFunction function, OpenApiOperation op`
`287`	`287`	`operation.Parameters.AppendParameter(countParameter);`
`288`	`288`	`}`
`289`	`289`
`290`		`- if (function.ReturnType?.Definition?.AsElementType() is IEdmEntityType entityType)`
	`290`	`+ if (functionReturnType?.Definition?.AsElementType() is IEdmEntityType entityType)`
`291`	`291`	`{`
`292`	`292`	`// $select`
`293`	`293`	`if (Context.CreateSelect(function, entityType) is {} selectParameter)`
`@@ -347,7 +347,7 @@ protected override void SetExternalDocs(OpenApiOperation operation)`
`347`	`347`	`// <inheritdoc/>`
`348`	`348`	`protected override void SetExtensions(OpenApiOperation operation)`
`349`	`349`	`{`
`350`		`- if (Context is { Settings.EnablePagination: true } && EdmOperation?.ReturnType?.TypeKind() == EdmTypeKind.Collection)`
	`350`	`+ if (Context is { Settings.EnablePagination: true } && EdmOperation?.GetReturn()?.Type?.TypeKind() == EdmTypeKind.Collection)`
`351`	`351`	`{`
`352`	`352`	`var extension = new JsonObject`
`353`	`353`	`{`
Original file line number	Diff line number	Diff line change
`@@ -342,7 +342,7 @@ public void CreateOperationForEdmActionWithCollectionReturnTypeContainsXMsPageab`
`342`	`342`	`var operation = _operationHandler.CreateOperation(context, path);`
`343`	`343`
`344`	`344`	`// Assert`
`345`		`- if (enablePagination && action.ReturnType.IsCollection())`
	`345`	`+ if (enablePagination && action.GetReturn()?.Type?.IsCollection() == true)`
`346`	`346`	`{`
`347`	`347`	`Assert.True(operation.Extensions.ContainsKey(Common.Constants.xMsPageable));`
`348`	`348`	`}`
Original file line number	Diff line number	Diff line change
`@@ -546,7 +546,7 @@ public void CreateOperationForEdmFunctionWithCollectionReturnTypeContainsXMsPage`
`546`	`546`	`var operation = _operationHandler.CreateOperation(context, path);`
`547`	`547`
`548`	`548`	`// Assert`
`549`		`- if (enablePagination && function.ReturnType.IsCollection())`
	`549`	`+ if (enablePagination && function.GetReturn()?.Type?.IsCollection() == true)`
`550`	`550`	`{`
`551`	`551`	`Assert.True(operation.Extensions.ContainsKey(Common.Constants.xMsPageable));`
`552`	`552`	`}`