Appends OData query parameters to functions (#267)

* Update test and integration files

* Add system query option parameters to functions

* Simplify retrieval of IndexableByKey annotation

* Remove unnecessary usings

* Update src/Microsoft.OpenApi.OData.Reader/Operation/EdmOperationOperationHandler.cs

Co-authored-by: Vincent Biret <[email protected]>

* Rename variables; get $select and $orderby parameters

* Update integration files

Co-authored-by: Vincent Biret <[email protected]>

Author: irvinesunday

src/Microsoft.OpenApi.OData.Reader/Edm/ODataPathProvider.cs

@@ -403,16 +403,17 @@ private void RetrieveNavigationPropertyPaths(
             visitedNavigationProperties.Push(navPropFullyQualifiedName);
 
             // Check whether a collection-valued navigation property should be indexed by key value(s).
+            // Find indexability annotation annotated directly via NavigationPropertyRestriction.
+            bool? annotatedIndexability = _model.GetBoolean(navigationProperty, CapabilitiesConstants.IndexableByKey);
             bool indexableByKey = true;
 
             if (restriction?.IndexableByKey != null)
             {
                 indexableByKey = (bool)restriction.IndexableByKey;
             }
-            else if (_model.FindVocabularyAnnotations<IEdmVocabularyAnnotation>(navigationProperty, CapabilitiesConstants.IndexableByKey).FirstOrDefault() is IEdmVocabularyAnnotation indexabilityAnnotation && indexabilityAnnotation.Value is IEdmBooleanValue booleanValue)
+            else if (annotatedIndexability != null)
             {
-                // Find indexability annotation annotated directly via NavigationPropertyRestriction
-                indexableByKey = booleanValue.Value;
+                indexableByKey = annotatedIndexability.Value;
             }
 
             if (indexableByKey)

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

@@ -1,11 +1,12 @@
-// ------------------------------------------------------------
+// ------------------------------------------------------------
 //  Copyright (c) Microsoft Corporation.  All rights reserved.
 //  Licensed under the MIT License (MIT). See LICENSE in the repo root for license information.
 // ------------------------------------------------------------
 
 using System.Collections.Generic;
 using System.Linq;
 using Microsoft.OData.Edm;
+using Microsoft.OData.Edm.Vocabularies;
 using Microsoft.OpenApi.Any;
 using Microsoft.OpenApi.Models;
 using Microsoft.OpenApi.OData.Common;
@@ -158,6 +159,8 @@ protected override void SetParameters(OpenApiOperation operation)
                         }
                     }
                 }
+
+                AppendSystemQueryOptions(function, operation);
             }
         }
 
@@ -200,6 +203,57 @@ protected override void AppendCustomParameters(OpenApiOperation operation)
             }
         }
 
+        private void AppendSystemQueryOptions(IEdmFunction function, OpenApiOperation operation)
+        {
+            if (function.ReturnType.IsCollection())
+            {
+                // $top
+                if (Context.CreateTop(function) is OpenApiParameter topParameter)
+                {
+                    operation.Parameters.AppendParameter(topParameter);
+                }
+
+                // $skip
+                if (Context.CreateSkip(function) is OpenApiParameter skipParameter)
+                {
+                    operation.Parameters.AppendParameter(skipParameter);
+                }
+
+                // $search
+                if (Context.CreateSearch(function) is OpenApiParameter searchParameter)
+                {
+                    operation.Parameters.AppendParameter(searchParameter);
+                }
+
+                // $filter
+                if (Context.CreateFilter(function) is OpenApiParameter filterParameter)
+                {
+                    operation.Parameters.AppendParameter(filterParameter);
+                }
+
+                // $count
+                if (Context.CreateCount(function) is OpenApiParameter countParameter)
+                {
+                    operation.Parameters.AppendParameter(countParameter);
+                }
+
+                if (function.ReturnType?.Definition?.AsElementType() is IEdmEntityType entityType)
+                {
+                    // $select
+                    if (Context.CreateSelect(function, entityType) is OpenApiParameter selectParameter)
+                    {
+                        operation.Parameters.AppendParameter(selectParameter);
+                    }
+
+                    // $orderby
+                    if (Context.CreateOrderBy(function, entityType) is OpenApiParameter orderbyParameter)
+                    {
+                        operation.Parameters.AppendParameter(orderbyParameter);
+                    }
+                }
+            }
+        }
+
         /// <inheritdoc/>
         protected override void SetCustomLinkRelType()
         {
@@ -211,9 +265,8 @@ protected override void SetCustomLinkRelType()
             }
         }
 
-
-    /// <inheritdoc/>
-    protected override void SetExternalDocs(OpenApiOperation operation)
+        /// <inheritdoc/>
+        protected override void SetExternalDocs(OpenApiOperation operation)
         {
             if (Context.Settings.ShowExternalDocs && Context.Model.GetLinkRecord(EdmOperation, CustomLinkRel) is Link externalDocs)
             {

test/Microsoft.OpenAPI.OData.Reader.Tests/Operation/EdmFunctionOperationHandlerTests.cs

@@ -139,8 +139,8 @@ public void CreateOperationForEdmFunctionReturnsCorrectOperationHierarchicalClas
             Assert.Equal($"{entitySetName}.Functions", tag.Name);
 
             Assert.NotNull(operation.Parameters);
-            Assert.Equal(1, operation.Parameters.Count);
-            Assert.Equal(new string[] { "id" }, operation.Parameters.Select(p => p.Name));
+            Assert.Equal(6, operation.Parameters.Count); // id, top, skip, count, search, filter
+            Assert.Contains("id", operation.Parameters.Select(x => x.Name).FirstOrDefault());
 
             Assert.Null(operation.RequestBody);