Respect [ApiExplorerSettings(IgnoreApi = false)]. Fixes #405.

Author: Chris Martinez

src/Microsoft.AspNetCore.OData.Versioning.ApiExplorer/AspNetCore.Mvc.ApiExplorer/ODataApiDescriptionProvider.cs

@@ -153,16 +153,9 @@ public virtual void OnProvidersExecuted( ApiDescriptionProviderContext context )
 
             foreach ( var action in context.Actions.OfType<ControllerActionDescriptor>() )
             {
-                if ( !action.ControllerTypeInfo.IsODataController() || action.ControllerTypeInfo.IsMetadataController() )
-                {
-                    continue;
-                }
-
-                var controller = action.GetProperty<ControllerModel>();
-                var apiExplorer = controller?.ApiExplorer;
-                var visible = ignoreApiExplorerSettings || ( apiExplorer?.IsVisible ?? true );
-
-                if ( !visible )
+                if ( !action.ControllerTypeInfo.IsODataController() ||
+                      action.ControllerTypeInfo.IsMetadataController() ||
+                     !IsVisible( action ) )
                 {
                     continue;
                 }
@@ -226,6 +219,27 @@ public virtual void OnProvidersExecuted( ApiDescriptionProviderContext context )
         /// <remarks>The default implementation performs no operation.</remarks>
         public virtual void OnProvidersExecuting( ApiDescriptionProviderContext context ) { }
 
+        /// <summary>
+        /// Returns a value indicating whether the specified action is visible to the API Explorer.
+        /// </summary>
+        /// <param name="action">The <see cref="ActionDescriptor">action</see> to evaluate.</param>
+        /// <returns>True if the <paramref name="action"/> is visible; otherwise, false.</returns>
+        protected bool IsVisible( ActionDescriptor action )
+        {
+            Arg.NotNull( action, nameof( action ) );
+
+            var ignoreApiExplorerSettings = !Options.UseApiExplorerSettings;
+
+            if ( ignoreApiExplorerSettings )
+            {
+                return true;
+            }
+
+            return action.GetProperty<ApiExplorerModel>()?.IsODataVisible() ??
+                   action.GetProperty<ControllerModel>()?.ApiExplorer?.IsODataVisible() ??
+                   false;
+        }
+
         /// <summary>
         /// Populates the API version parameters for the specified API description.
         /// </summary>

src/Microsoft.AspNetCore.OData.Versioning/AspNetCore.Mvc/ApplicationModels/ApiExplorerModelExtensions.cs

@@ -0,0 +1,22 @@
+namespace Microsoft.AspNetCore.Mvc.ApplicationModels
+{
+    using System;
+
+    /// <summary>
+    /// Provides extension methods for the <see cref="ApiExplorerModel"/> class.
+    /// </summary>
+    [CLSCompliant( false )]
+    public static class ApiExplorerModelExtensions
+    {
+        /// <summary>
+        /// Returns a value indicating whether the specified model is visible to OData.
+        /// </summary>
+        /// <param name="model">The <see cref="ApiExplorerModel">model</see> to evaluate.</param>
+        /// <returns>True if the associated controller or action is visible to OData; otherwise, false.</returns>
+        public static bool? IsODataVisible( this ApiExplorerModel model )
+        {
+            Arg.NotNull( model, nameof( model ) );
+            return model is ODataApiExplorerModel odataModel ? odataModel.IsODataVisible : model.IsVisible;
+        }
+    }
+}

src/Microsoft.AspNetCore.OData.Versioning/AspNetCore.Mvc/ApplicationModels/ODataApiExplorerModel.cs

@@ -0,0 +1,46 @@
+namespace Microsoft.AspNetCore.Mvc.ApplicationModels
+{
+    using System;
+
+    /// <summary>
+    /// Represents a model for the API Explorer for an OData controller or action.
+    /// </summary>
+    [CLSCompliant( false )]
+    public class ODataApiExplorerModel : ApiExplorerModel
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ODataApiExplorerModel"/> class.
+        /// </summary>
+        public ODataApiExplorerModel() { }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ODataApiExplorerModel"/> class.
+        /// </summary>
+        /// <param name="other">The other <see cref="ApiExplorerModel">model</see> to copy from.</param>
+        public ODataApiExplorerModel( ApiExplorerModel other ) : base( other )
+        {
+            Arg.NotNull( other, nameof( other ) );
+
+            IsVisible = null;
+            IsODataVisible = other.IsVisible;
+        }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ODataApiExplorerModel"/> class.
+        /// </summary>
+        /// <param name="other">The other <see cref="ODataApiExplorerModel">model</see> to copy from.</param>
+        public ODataApiExplorerModel( ODataApiExplorerModel other ) : base( other )
+        {
+            Arg.NotNull( other, nameof( other ) );
+
+            IsVisible = null;
+            IsODataVisible = other.IsODataVisible;
+        }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether the OData controller or action will be visible in the API Explorer.
+        /// </summary>
+        /// <value>True if the OData controller or action will be visible in the API Explorer; otherwise, false.</value>
+        public bool? IsODataVisible { get; set; }
+    }
+}

src/Microsoft.AspNetCore.OData.Versioning/AspNetCore.Mvc/Versioning/ApiExplorerModelConvention.cs

@@ -0,0 +1,33 @@
+namespace Microsoft.AspNetCore.Mvc.Versioning
+{
+    using Microsoft.AspNet.OData;
+    using Microsoft.AspNetCore.Mvc.ApplicationModels;
+
+    sealed class ApiExplorerModelConvention : IApplicationModelConvention
+    {
+        public void Apply( ApplicationModel application )
+        {
+            foreach ( var controller in application.Controllers )
+            {
+                if ( !controller.ControllerType.IsODataController() )
+                {
+                    continue;
+                }
+
+                if ( controller.ApiExplorer != null )
+                {
+                    controller.ApiExplorer = new ODataApiExplorerModel( controller.ApiExplorer );
+                }
+
+                foreach ( var action in controller.Actions )
+                {
+                    if ( action.ApiExplorer != null )
+                    {
+                        action.ApiExplorer = new ODataApiExplorerModel( action.ApiExplorer );
+                        action.SetProperty( action.ApiExplorer );
+                    }
+                }
+            }
+        }
+    }
+}

src/Microsoft.AspNetCore.OData.Versioning/AspNetCore.Mvc/Versioning/ODataApplicationModelProvider.cs

@@ -16,8 +16,17 @@ sealed class ODataApplicationModelProvider : IApplicationModelProvider
 
         public void OnProvidersExecuted( ApplicationModelProviderContext context )
         {
-            var convention = new MetadataControllerConvention( Options );
-            convention.Apply( context.Result );
+            var application = context.Result;
+            var conventions = new IApplicationModelConvention[]
+            {
+                new MetadataControllerConvention( Options ),
+                new ApiExplorerModelConvention(),
+            };
+
+            for ( var i = 0; i < conventions.Length; i++ )
+            {
+                conventions[i].Apply( application );
+            }
         }
 
         public void OnProvidersExecuting( ApplicationModelProviderContext context ) { }