Do not override global settings when visiting EnableQueryAttribute. Fixes #488

Author: Chris Martinez

samples/aspnetcore/SwaggerODataSample/Startup.cs

@@ -43,10 +43,16 @@ public void ConfigureServices( IServiceCollection services )
 
                     // configure query options (which cannot otherwise be configured by OData conventions)
                     options.QueryOptions.Controller<V2.PeopleController>()
-                                        .Action( c => c.Get( default ) ).Allow( Skip | Count ).AllowTop( 100 );
+                                        .Action( c => c.Get( default ) )
+                                            .Allow( Skip | Count )
+                                            .AllowTop( 100 )
+                                            .AllowOrderBy( "firstName", "lastName" );
 
                     options.QueryOptions.Controller<V3.PeopleController>()
-                                        .Action( c => c.Get( default ) ).Allow( Skip | Count ).AllowTop( 100 );
+                                        .Action( c => c.Get( default ) )
+                                            .Allow( Skip | Count )
+                                            .AllowTop( 100 )
+                                            .AllowOrderBy( "firstName", "lastName" );
                 } );
             services.AddTransient<IConfigureOptions<SwaggerGenOptions>, ConfigureSwaggerOptions>();
             services.AddSwaggerGen(

samples/webapi/SwaggerODataWebApiSample/Startup.cs

@@ -74,10 +74,16 @@ public void Configuration( IAppBuilder builder )
 
                     // configure query options (which cannot otherwise be configured by OData conventions)
                     options.QueryOptions.Controller<V2.PeopleController>()
-                                        .Action( c => c.Get( default ) ).Allow( Skip | Count ).AllowTop( 100 );
+                                        .Action( c => c.Get( default ) )
+                                            .Allow( Skip | Count )
+                                            .AllowTop( 100 )
+                                            .AllowOrderBy( "firstName", "lastName" );
 
                     options.QueryOptions.Controller<V3.PeopleController>()
-                                        .Action( c => c.Get( default ) ).Allow( Skip | Count ).AllowTop( 100 );
+                                        .Action( c => c.Get( default ) )
+                                            .Allow( Skip | Count )
+                                            .AllowTop( 100 )
+                                            .AllowOrderBy( "firstName", "lastName" );
                 } );
 
             configuration.EnableSwagger(

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

@@ -129,7 +129,7 @@ void VisitEnableQuery( IReadOnlyList<EnableQueryAttribute> attributes )
 
                 if ( attribute.AllowedArithmeticOperators == AllowedArithmeticOperators.None )
                 {
-                    attribute.AllowedArithmeticOperators = AllowedArithmeticOperators.None;
+                    context.AllowedArithmeticOperators = AllowedArithmeticOperators.None;
                 }
                 else
                 {
@@ -138,7 +138,7 @@ void VisitEnableQuery( IReadOnlyList<EnableQueryAttribute> attributes )
 
                 if ( attribute.AllowedFunctions == AllowedFunctions.None )
                 {
-                    attribute.AllowedFunctions = AllowedFunctions.None;
+                    context.AllowedFunctions = AllowedFunctions.None;
                 }
                 else
                 {
@@ -147,7 +147,7 @@ void VisitEnableQuery( IReadOnlyList<EnableQueryAttribute> attributes )
 
                 if ( attribute.AllowedLogicalOperators == AllowedLogicalOperators.None )
                 {
-                    attribute.AllowedLogicalOperators = AllowedLogicalOperators.None;
+                    context.AllowedLogicalOperators = AllowedLogicalOperators.None;
                 }
                 else
                 {
@@ -156,7 +156,7 @@ void VisitEnableQuery( IReadOnlyList<EnableQueryAttribute> attributes )
 
                 if ( attribute.AllowedQueryOptions == AllowedQueryOptions.None )
                 {
-                    attribute.AllowedQueryOptions = AllowedQueryOptions.None;
+                    AllowedQueryOptions = AllowedQueryOptions.None;
                 }
                 else
                 {
@@ -250,7 +250,12 @@ void VisitCount( ModelBoundQuerySettings querySettings )
         {
             Contract.Requires( querySettings != null );
 
-            if ( querySettings.Countable == true )
+            if ( !querySettings.Countable.HasValue )
+            {
+                return;
+            }
+
+            if ( querySettings.Countable.Value )
             {
                 AllowedQueryOptions |= Count;
             }
@@ -348,22 +353,59 @@ void Visit<TSetting>(
 
             foreach ( var property in allowedProperties )
             {
-                queryableProperties.Add( property );
+                if ( !queryableProperties.Contains( property, comparer ) )
+                {
+                    queryableProperties.Add( property );
+                }
+            }
+        }
+
+        bool IsSelectEnabled( ModelBoundQuerySettings querySettings )
+        {
+            if ( !querySettings.DefaultSelectType.HasValue )
+            {
+                return AllowedQueryOptions.HasFlag( Select ) ||
+                       querySettings.SelectConfigurations.Any( p => p.Value != Disabled );
+            }
+
+            return querySettings.DefaultSelectType.Value != Disabled ||
+                   querySettings.SelectConfigurations.Any( p => p.Value != Disabled );
+        }
+
+        bool IsExpandEnabled( ModelBoundQuerySettings querySettings )
+        {
+            if ( !querySettings.DefaultExpandType.HasValue )
+            {
+                return AllowedQueryOptions.HasFlag( Expand ) ||
+                       querySettings.ExpandConfigurations.Any( p => p.Value.ExpandType != Disabled );
             }
+
+            return querySettings.DefaultExpandType.Value != Disabled ||
+                   querySettings.ExpandConfigurations.Any( p => p.Value.ExpandType != Disabled );
         }
 
-        static bool IsSelectEnabled( ModelBoundQuerySettings querySettings ) =>
-            ( querySettings.DefaultSelectType != null && querySettings.DefaultSelectType.Value != Disabled ) ||
-            querySettings.SelectConfigurations.Any( p => p.Value != Disabled );
+        bool IsFilterEnabled( ModelBoundQuerySettings querySettings )
+        {
+            if ( !querySettings.DefaultEnableFilter.HasValue )
+            {
+                return AllowedQueryOptions.HasFlag( Filter ) ||
+                       querySettings.FilterConfigurations.Any( p => p.Value );
+            }
 
-        static bool IsExpandEnabled( ModelBoundQuerySettings querySettings ) =>
-            ( querySettings.DefaultExpandType != null && querySettings.DefaultExpandType.Value != Disabled ) ||
-            querySettings.ExpandConfigurations.Any( p => p.Value.ExpandType != Disabled );
+            return querySettings.DefaultEnableFilter.Value ||
+                   querySettings.FilterConfigurations.Any( p => p.Value );
+        }
 
-        static bool IsFilterEnabled( ModelBoundQuerySettings querySettings ) =>
-            querySettings.DefaultEnableFilter == true || querySettings.FilterConfigurations.Any( p => p.Value );
+        bool IsOrderByEnabled( ModelBoundQuerySettings querySettings )
+        {
+            if ( !querySettings.DefaultEnableOrderBy.HasValue )
+            {
+                return AllowedQueryOptions.HasFlag( OrderBy ) ||
+                       querySettings.OrderByConfigurations.Any( p => p.Value );
+            }
 
-        static bool IsOrderByEnabled( ModelBoundQuerySettings querySettings ) =>
-            querySettings.DefaultEnableOrderBy == true || querySettings.OrderByConfigurations.Any( p => p.Value );
+            return querySettings.DefaultEnableOrderBy.Value ||
+                   querySettings.OrderByConfigurations.Any( p => p.Value );
+        }
     }
 }

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

@@ -39,7 +39,7 @@ protected internal ODataQueryOptionDescriptionContext( ODataValidationSettings v
         }
 
         /// <summary>
-        /// Gets or sets the allowed arthmetic operators.
+        /// Gets or sets the allowed arithmetic operators.
         /// </summary>
         /// <value>One or more of the <see cref="AllowedArithmeticOperators"/> values.</value>
         public AllowedArithmeticOperators AllowedArithmeticOperators { get; set; }