Support separate client and server OData route template generation. Fixes #502

Author: Chris Martinez

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

@@ -18,6 +18,7 @@
 #endif
     using static Microsoft.OData.ODataUrlKeyDelimiter;
     using static ODataRouteActionType;
+    using static ODataRouteTemplateGenerationKind;
     using static System.Linq.Enumerable;
     using static System.String;
     using static System.StringComparison;
@@ -298,6 +299,11 @@ void ExpandParameterTemplate( StringBuilder template, IEdmTypeReference typeRefe
             template.Append( name );
             template.Append( "}" );
 
+            if ( Context.RouteTemplateGeneration == Server )
+            {
+                return;
+            }
+
             if ( typeDef.TypeKind == EdmTypeKind.Enum )
             {
                 var fullName = typeReference.FullName();

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

@@ -22,6 +22,7 @@
     using System.Web.Http.Dispatcher;
     using ControllerActionDescriptor = System.Web.Http.Controllers.HttpActionDescriptor;
 #endif
+    using static ODataRouteTemplateGenerationKind;
 
     sealed partial class ODataRouteBuilderContext
     {
@@ -34,8 +35,12 @@ sealed partial class ODataRouteBuilderContext
         internal ODataApiExplorerOptions Options { get; }
 
         internal IList<ApiParameterDescription> ParameterDescriptions { get; }
+
+        internal ODataRouteTemplateGenerationKind RouteTemplateGeneration { get; } = Client;
 #else
         internal IList<ParameterDescriptor> ParameterDescriptions => ActionDescriptor.Parameters;
+
+        internal ODataRouteTemplateGenerationKind RouteTemplateGeneration { get; } = Server;
 #endif
 
         internal IEdmModel EdmModel { get; }

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

@@ -0,0 +1,10 @@
+namespace Microsoft.AspNet.OData.Routing
+{
+    using System;
+
+    internal enum ODataRouteTemplateGenerationKind
+    {
+        Client,
+        Server,
+    }
+}

src/Common.OData.ApiExplorer/Common.OData.ApiExplorer.projitems

@@ -42,6 +42,7 @@
     <Compile Include="$(MSBuildThisFileDirectory)AspNet.OData\Routing\ODataRouteActionType.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)AspNet.OData\Routing\ODataRouteBuilder.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)AspNet.OData\Routing\ODataRouteBuilderContext.cs" />
+    <Compile Include="$(MSBuildThisFileDirectory)AspNet.OData\Routing\ODataRouteTemplateGenerationKind.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)AspNet.OData\StructuredTypeResolver.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)AspNet.OData\TypeSubstitutionContext.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)AspNet.OData\TypeExtensions.cs" />

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

@@ -497,36 +497,44 @@ void UpdateBindingInfo( ApiParameterContext context, ParameterDescriptor paramet
             var parameterType = parameter.ParameterType;
             var bindingInfo = parameter.BindingInfo;
 
-            if ( bindingInfo != null )
+            bool IsSpecialBindingSource( BindingInfo info, Type type )
             {
-                if ( ( parameterType.IsODataQueryOptions() || parameterType.IsODataPath() ) && bindingInfo.BindingSource == Custom )
+                if ( info == null )
                 {
-                    bindingInfo.BindingSource = Special;
+                    return false;
                 }
 
-                return;
+                if ( ( type.IsODataQueryOptions() || type.IsODataPath() ) && info.BindingSource == Custom )
+                {
+                    info.BindingSource = Special;
+                    return true;
+                }
+
+                return false;
             }
 
-            parameter.BindingInfo = bindingInfo = new BindingInfo() { BindingSource = metadata.BindingSource };
+            if ( IsSpecialBindingSource( bindingInfo, parameterType ) )
+            {
+                return;
+            }
 
-            if ( bindingInfo.BindingSource != null )
+            if ( bindingInfo == null )
             {
-                if ( ( parameterType.IsODataQueryOptions() || parameterType.IsODataPath() ) && bindingInfo.BindingSource == Custom )
+                parameter.BindingInfo = bindingInfo = new BindingInfo() { BindingSource = metadata.BindingSource };
+
+                if ( IsSpecialBindingSource( bindingInfo, parameterType ) )
                 {
-                    bindingInfo.BindingSource = Special;
+                    return;
                 }
-
-                return;
             }
 
             var key = default( IEdmNamedElement );
             var paramName = parameter.Name;
-            var source = Query;
+            var source = bindingInfo.BindingSource;
 
             switch ( context.RouteContext.ActionType )
             {
                 case EntitySet:
-
                     var keys = context.RouteContext.EntitySet.EntityType().Key().ToArray();
 
                     key = keys.FirstOrDefault( k => k.Name.Equals( paramName, OrdinalIgnoreCase ) );
@@ -553,7 +561,6 @@ void UpdateBindingInfo( ApiParameterContext context, ParameterDescriptor paramet
                     break;
                 case BoundOperation:
                 case UnboundOperation:
-
                     var operation = context.RouteContext.Operation;
 
                     if ( operation == null )
@@ -575,10 +582,13 @@ void UpdateBindingInfo( ApiParameterContext context, ParameterDescriptor paramet
                         source = Path;
                     }
 
+                    break;
+                default:
+                    source = Query;
                     break;
             }
 
-            bindingInfo.BindingSource = source;
+            bindingInfo.BindingSource = source ?? Query;
             parameter.BindingInfo = bindingInfo;
         }