Add OData query option support for non-OData actions. Resolves #522

Author: Chris Martinez

src/Common.OData.ApiExplorer/AspNet.OData/Builder/DefaultODataQueryOptionDescriptionProvider.cs

@@ -30,26 +30,18 @@ public virtual string Describe( AllowedQueryOptions queryOption, ODataQueryOptio
                 throw new ArgumentException( SR.MultipleQueryOptionsNotAllowed, nameof( queryOption ) );
             }
 
-            switch ( queryOption )
+            return queryOption switch
             {
-                case Filter:
-                    return DescribeFilter( context );
-                case Expand:
-                    return DescribeExpand( context );
-                case Select:
-                    return DescribeSelect( context );
-                case OrderBy:
-                    return DescribeOrderBy( context );
-                case Top:
-                    return DescribeTop( context );
-                case Skip:
-                    return DescribeSkip( context );
-                case Count:
-                    return DescribeCount( context );
-            }
-
+                Filter => DescribeFilter( context ),
+                Expand => DescribeExpand( context ),
+                Select => DescribeSelect( context ),
+                OrderBy => DescribeOrderBy( context ),
+                Top => DescribeTop( context ),
+                Skip => DescribeSkip( context ),
+                Count => DescribeCount( context ),
 #pragma warning disable CA1308 // Normalize strings to uppercase
-            throw new ArgumentException( SR.UnsupportedQueryOption.FormatDefault( queryOption.ToString().ToLowerInvariant() ), nameof( queryOption ) );
+                _ => throw new ArgumentException( SR.UnsupportedQueryOption.FormatDefault( queryOption.ToString().ToLowerInvariant() ), nameof( queryOption ) ),
+            };
 #pragma warning restore CA1308
         }
 

src/Common.OData.ApiExplorer/AspNet.OData/Builder/ODataActionQueryOptionsConventionBuilderExtensions.cs

@@ -137,7 +137,7 @@ public static ODataActionQueryOptionsConventionBuilder Action( this IODataAction
                     return builder.Action( methods[0] );
             }
 
-            argumentTypes = argumentTypes ?? Type.EmptyTypes;
+            argumentTypes ??= Type.EmptyTypes;
             methods = methods.Where( m => SignatureMatches( m, argumentTypes ) ).ToArray();
 
             if ( methods.Length == 1 )

src/Common.OData.ApiExplorer/AspNet.OData/Builder/ODataAttributeVisitor.cs

@@ -68,28 +68,6 @@ internal void Visit( ApiDescription apiDescription )
             }
         }
 
-        static void ClearCollectionIfItContainsAllProperties( IList<string> list, ISet<string> set )
-        {
-            Contract.Requires( list != null );
-            Contract.Requires( set != null );
-
-            if ( list.Count != set.Count )
-            {
-                return;
-            }
-
-            for ( var i = 0; i < list.Count; i++ )
-            {
-                if ( !set.Contains( list[i] ) )
-                {
-                    return;
-                }
-            }
-
-            // avoid verbose messages by clearing the list when it contains all possible properties
-            list.Clear();
-        }
-
         void VisitModel( IEdmStructuredType modelType )
         {
             Contract.Requires( modelType != null );

src/Common.OData.ApiExplorer/AspNet.OData/Builder/ODataQueryOptionsConventionBuilder.cs

@@ -137,13 +137,13 @@ public virtual void ApplyTo( IEnumerable<ApiDescription> apiDescriptions, ODataQ
             {
                 var controller = GetController( description );
 
-                if ( !controller.IsODataController() )
-                {
-                    continue;
-                }
-
                 if ( !conventions.TryGetValue( controller, out var convention ) )
                 {
+                    if ( !controller.IsODataController() && !IsODataLike( description ) )
+                    {
+                        continue;
+                    }
+
                     if ( !ConventionBuilders.TryGetValue( controller, out var builder ) )
                     {
                         builder = new ODataControllerQueryOptionsConventionBuilder( controller );

src/Common.OData.ApiExplorer/AspNet.OData/Routing/ODataRouteBuilder.cs

@@ -354,7 +354,7 @@ string FixUpArrayParameters( string template, IEdmOperation operation )
                 return template;
             }
 
-            int IndexOfToken( StringBuilder builder, string token )
+            static int IndexOfToken( StringBuilder builder, string token )
             {
                 var index = -1;
 
@@ -393,7 +393,7 @@ int IndexOfToken( StringBuilder builder, string token )
                 return index;
             }
 
-            void InsertBrackets( StringBuilder builder, string token )
+            static void InsertBrackets( StringBuilder builder, string token )
             {
                 var index = IndexOfToken( builder, token );
 

src/Common.OData.ApiExplorer/AspNet.OData/StructuredTypeResolver.cs

@@ -16,6 +16,11 @@ internal IEdmStructuredType GetStructuredType( Type type )
         {
             Contract.Requires( type != null );
 
+            if ( model == null )
+            {
+                return default;
+            }
+
             var structuredTypes = model.SchemaElements.OfType<IEdmStructuredType>();
             var structuredType = structuredTypes.FirstOrDefault( t => type.Equals( t.GetClrType( model ) ) );
 

src/Microsoft.AspNet.OData.Versioning.ApiExplorer/AspNet.OData/Builder/ODataQueryOptionsConventionBuilder.cs

@@ -10,6 +10,10 @@ public partial class ODataQueryOptionsConventionBuilder
     {
         static Type GetKey( Type type ) => type;
 
-        static Type GetController( ApiDescription apiDescription ) => apiDescription.ActionDescriptor.ControllerDescriptor.ControllerType;
+        static Type GetController( ApiDescription apiDescription ) =>
+            apiDescription.ActionDescriptor.ControllerDescriptor.ControllerType;
+
+        static bool IsODataLike( ApiDescription description ) =>
+            description.ActionDescriptor.GetCustomAttributes<EnableQueryAttribute>( inherit: true ).Count > 0;
     }
 }

src/Microsoft.AspNet.OData.Versioning.ApiExplorer/AspNet.OData/Builder/ODataValidationSettingsConvention.cs

@@ -157,17 +157,12 @@ static bool IsSupported( ApiDescription apiDescription )
         {
             Contract.Requires( apiDescription != null );
 
-            switch ( apiDescription.HttpMethod.Method.ToUpperInvariant() )
+            return apiDescription.HttpMethod.Method.ToUpperInvariant() switch
             {
-                case "GET":
-                    // query or function
-                    return true;
-                case "POST":
-                    // action
-                    return apiDescription.Operation()?.IsAction() == true;
-            }
-
-            return false;
+                "GET" => true,
+                "POST" => apiDescription.Operation()?.IsAction() == true,
+                _ => false,
+            };
         }
     }
 }

src/Microsoft.AspNetCore.OData.Versioning.ApiExplorer/AspNet.OData/Builder/ODataQueryOptionsConventionBuilder.cs

@@ -1,9 +1,7 @@
 namespace Microsoft.AspNet.OData.Builder
 {
-    using Microsoft.AspNet.OData.Query;
     using Microsoft.AspNetCore.Mvc.ApiExplorer;
     using Microsoft.AspNetCore.Mvc.Controllers;
-    using Microsoft.AspNetCore.Mvc.ModelBinding;
     using System;
     using System.Reflection;
 
@@ -24,5 +22,15 @@ static TypeInfo GetController( ApiDescription apiDescription )
 
             return typeof( object ).GetTypeInfo();
         }
+
+        static bool IsODataLike( ApiDescription description )
+        {
+            if ( description.ActionDescriptor is ControllerActionDescriptor action )
+            {
+                return Attribute.IsDefined( action.ControllerTypeInfo, typeof( EnableQueryAttribute ), inherit: true );
+            }
+
+            return false;
+        }
     }
 }

src/Microsoft.AspNetCore.OData.Versioning.ApiExplorer/AspNet.OData/Builder/ODataValidationSettingsConvention.cs

@@ -165,17 +165,12 @@ static bool IsSupported( ApiDescription apiDescription )
         {
             Contract.Requires( apiDescription != null );
 
-            switch ( apiDescription.HttpMethod.ToUpperInvariant() )
+            return apiDescription.HttpMethod.ToUpperInvariant() switch
             {
-                case "GET":
-                    // query or function
-                    return true;
-                case "POST":
-                    // action
-                    return apiDescription.Operation()?.IsAction() == true;
-            }
-
-            return false;
+                "GET" => true,
+                "POST" => apiDescription.Operation()?.IsAction() == true,
+                _ => false,
+            };
         }
     }
 }