Restore functionality to report versions when unmatched. Fixes #876. Fixes #918.

Author: commonsensesoftware

src/AspNet/Acceptance/Asp.Versioning.WebApi.Acceptance.Tests/Http/Basic/given a versioned ApiController/when using a query string and split into two types.cs

@@ -34,7 +34,7 @@ public async Task then_get_should_return_200( string controller, string apiVersi
     }
 
     [Fact]
-    public async Task then_get_should_return_404_for_an_unsupported_version()
+    public async Task then_get_should_return_400_for_an_unsupported_version()
     {
         // arrange
 
@@ -44,7 +44,7 @@ public async Task then_get_should_return_404_for_an_unsupported_version()
         var problem = await response.Content.ReadAsProblemDetailsAsync();
 
         // assert
-        response.StatusCode.Should().Be( NotFound );
+        response.StatusCode.Should().Be( BadRequest );
         problem.Type.Should().Be( ProblemDetailsDefaults.Unsupported.Type );
     }
 

src/AspNet/Acceptance/Asp.Versioning.WebApi.Acceptance.Tests/Http/UsingConventions/given a versioned ApiController using conventions/when using a query string and split into two types.cs

@@ -35,7 +35,7 @@ public async Task then_get_should_return_200( string controller, string apiVersi
     }
 
     [Fact]
-    public async Task then_get_should_return_404_for_an_unsupported_version()
+    public async Task then_get_should_return_400_for_an_unsupported_version()
     {
         // arrange
 
@@ -45,7 +45,7 @@ public async Task then_get_should_return_404_for_an_unsupported_version()
         var problem = await response.Content.ReadAsProblemDetailsAsync();
 
         // assert
-        response.StatusCode.Should().Be( NotFound );
+        response.StatusCode.Should().Be( BadRequest );
         problem.Type.Should().Be( ProblemDetailsDefaults.Unsupported.Type );
     }
 

src/AspNet/Acceptance/Asp.Versioning.WebApi.Acceptance.Tests/Http/UsingNamespace/given a versioned ApiController per namespace/when using a query string.cs

@@ -32,7 +32,7 @@ public async Task then_get_should_return_200( Type controllerType, string apiVer
     }
 
     [Fact]
-    public async Task then_get_should_return_404_for_an_unsupported_version()
+    public async Task then_get_should_return_400_for_an_unsupported_version()
     {
         // arrange
 
@@ -42,7 +42,7 @@ public async Task then_get_should_return_404_for_an_unsupported_version()
         var problem = await response.Content.ReadAsProblemDetailsAsync();
 
         // assert
-        response.StatusCode.Should().Be( NotFound );
+        response.StatusCode.Should().Be( BadRequest );
         problem.Type.Should().Be( ProblemDetailsDefaults.Unsupported.Type );
     }
 

src/AspNet/Acceptance/Asp.Versioning.WebApi.Acceptance.Tests/OData/Advanced/given a versioned ODataController mixed with Web API controllers/when people is any version.cs

@@ -9,7 +9,7 @@ namespace given_a_versioned_ODataController_mixed_with_Web_API_controllers;
 public class when_people_is_any_version : AdvancedAcceptanceTest
 {
     [Fact]
-    public async Task then_patch_should_return_404_for_an_unsupported_version()
+    public async Task then_patch_should_return_400_for_an_unsupported_version()
     {
         // arrange
         var person = new { lastName = "Me" };
@@ -19,7 +19,7 @@ public async Task then_patch_should_return_404_for_an_unsupported_version()
         var problem = await response.Content.ReadAsProblemDetailsAsync();
 
         // assert
-        response.StatusCode.Should().Be( NotFound );
+        response.StatusCode.Should().Be( BadRequest );
         problem.Type.Should().Be( ProblemDetailsDefaults.Unsupported.Type );
     }
 

src/AspNet/Acceptance/Asp.Versioning.WebApi.Acceptance.Tests/OData/Basic/given a versioned ODataController/when using a query string and split into two types.cs

@@ -28,7 +28,7 @@ public async Task then_get_should_return_200( string requestUrl )
     }
 
     [Fact]
-    public async Task then_get_should_return_404_for_an_unsupported_version()
+    public async Task then_get_should_return_400_for_an_unsupported_version()
     {
         // arrange
 
@@ -38,7 +38,7 @@ public async Task then_get_should_return_404_for_an_unsupported_version()
         var problem = await response.Content.ReadAsProblemDetailsAsync();
 
         // assert
-        response.StatusCode.Should().Be( NotFound );
+        response.StatusCode.Should().Be( BadRequest );
         problem.Type.Should().Be( ProblemDetailsDefaults.Unsupported.Type );
     }
 
@@ -73,7 +73,7 @@ public async Task then_patch_should_return_405_if_supported_in_any_version( stri
     }
 
     [Fact]
-    public async Task then_patch_should_return_404_for_an_unsupported_version()
+    public async Task then_patch_should_return_400_for_an_unsupported_version()
     {
         // arrange
         var person = new { id = 42, firstName = "John", lastName = "Doe", email = "[email protected]" };
@@ -83,7 +83,7 @@ public async Task then_patch_should_return_404_for_an_unsupported_version()
         var problem = await response.Content.ReadAsProblemDetailsAsync();
 
         // assert
-        response.StatusCode.Should().Be( NotFound );
+        response.StatusCode.Should().Be( BadRequest );
         problem.Type.Should().Be( ProblemDetailsDefaults.Unsupported.Type );
     }
 

src/AspNet/Acceptance/Asp.Versioning.WebApi.Acceptance.Tests/OData/Basic/given a versioned ODataController/when using a query string.cs

@@ -24,7 +24,7 @@ public async Task then_get_should_return_200( string requestUrl )
     }
 
     [Fact]
-    public async Task then_get_should_return_404_for_an_unsupported_version()
+    public async Task then_get_should_return_400_for_an_unsupported_version()
     {
         // arrange
 
@@ -34,7 +34,7 @@ public async Task then_get_should_return_404_for_an_unsupported_version()
         var problem = await response.Content.ReadAsProblemDetailsAsync();
 
         // assert
-        response.StatusCode.Should().Be( NotFound );
+        response.StatusCode.Should().Be( BadRequest );
         problem.Type.Should().Be( ProblemDetailsDefaults.Unsupported.Type );
     }
 

src/AspNet/Acceptance/Asp.Versioning.WebApi.Acceptance.Tests/OData/ODataAcceptanceTest.cs

@@ -37,7 +37,7 @@ public async Task then_the_service_document_should_be_versionX2Dspecific( string
     }
 
     [Fact]
-    public async Task then_the_service_document_should_return_404_for_an_unsupported_version()
+    public async Task then_the_service_document_should_return_400_for_an_unsupported_version()
     {
         // arrange
 
@@ -47,7 +47,7 @@ public async Task then_the_service_document_should_return_404_for_an_unsupported
         var problem = await response.Content.ReadAsProblemDetailsAsync();
 
         // assert
-        response.StatusCode.Should().Be( NotFound );
+        response.StatusCode.Should().Be( BadRequest );
         problem.Type.Should().Be( ProblemDetailsDefaults.Unsupported.Type );
     }
 
@@ -83,7 +83,7 @@ public async Task then_X24metadata_should_be_versionX2Dspecific( string apiVersi
     }
 
     [Fact]
-    public async Task then_X24metadata_should_return_404_for_an_unsupported_version()
+    public async Task then_X24metadata_should_return_400_for_an_unsupported_version()
     {
         // arrange
         Client.DefaultRequestHeaders.Clear();
@@ -93,7 +93,7 @@ public async Task then_X24metadata_should_return_404_for_an_unsupported_version(
         var problem = await response.Content.ReadAsProblemDetailsAsync();
 
         // assert
-        response.StatusCode.Should().Be( NotFound );
+        response.StatusCode.Should().Be( BadRequest );
         problem.Type.Should().Be( ProblemDetailsDefaults.Unsupported.Type );
     }
 

src/AspNet/Acceptance/Asp.Versioning.WebApi.Acceptance.Tests/OData/UsingConventions/given a versioned ODataController using conventions/when using a query string and split into two types.cs

@@ -28,7 +28,7 @@ public async Task then_get_should_return_200( string requestUrl )
     }
 
     [Fact]
-    public async Task then_get_should_return_404_for_an_unsupported_version()
+    public async Task then_get_should_return_400_for_an_unsupported_version()
     {
         // arrange
 
@@ -38,7 +38,7 @@ public async Task then_get_should_return_404_for_an_unsupported_version()
         var problem = await response.Content.ReadAsProblemDetailsAsync();
 
         // assert
-        response.StatusCode.Should().Be( NotFound );
+        response.StatusCode.Should().Be( BadRequest );
         problem.Type.Should().Be( ProblemDetailsDefaults.Unsupported.Type );
     }
 
@@ -73,7 +73,7 @@ public async Task then_patch_should_return_405_if_supported_in_any_version( stri
     }
 
     [Fact]
-    public async Task then_patch_should_return_404_for_an_unsupported_version()
+    public async Task then_patch_should_return_400_for_an_unsupported_version()
     {
         // arrange
         var person = new { id = 42, firstName = "John", lastName = "Doe", email = "[email protected]" };
@@ -83,7 +83,7 @@ public async Task then_patch_should_return_404_for_an_unsupported_version()
         var problem = await response.Content.ReadAsProblemDetailsAsync();
 
         // assert
-        response.StatusCode.Should().Be( NotFound );
+        response.StatusCode.Should().Be( BadRequest );
         problem.Type.Should().Be( ProblemDetailsDefaults.Unsupported.Type );
     }
 

src/AspNet/Acceptance/Asp.Versioning.WebApi.Acceptance.Tests/OData/UsingConventions/given a versioned ODataController using conventions/when using a query string.cs

@@ -24,7 +24,7 @@ public async Task then_get_should_return_200( string requestUrl )
     }
 
     [Fact]
-    public async Task then_get_should_return_404_for_an_unsupported_version()
+    public async Task then_get_should_return_400_for_an_unsupported_version()
     {
         // arrange
 
@@ -34,7 +34,7 @@ public async Task then_get_should_return_404_for_an_unsupported_version()
         var problem = await response.Content.ReadAsProblemDetailsAsync();
 
         // assert
-        response.StatusCode.Should().Be( NotFound );
+        response.StatusCode.Should().Be( BadRequest );
         problem.Type.Should().Be( ProblemDetailsDefaults.Unsupported.Type );
     }
 

src/AspNet/WebApi/src/Asp.Versioning.WebApi/Dispatcher/HttpResponseExceptionFactory.cs

@@ -9,8 +9,6 @@ namespace Asp.Versioning.Dispatcher;
 using System.Web.Http.Tracing;
 using static System.Net.HttpStatusCode;
 
-#pragma warning disable CA2000 // Dispose objects before losing scope
-
 internal sealed class HttpResponseExceptionFactory
 {
     private const string Allow = nameof( Allow );
@@ -64,7 +62,8 @@ internal HttpResponseException NewUnmatchedException(
             }
         }
 
-        var versionsOnlyByMediaType = Options.ApiVersionReader.VersionsByMediaType( allowMultipleLocations: false );
+        var options = Options;
+        var versionsOnlyByMediaType = options.ApiVersionReader.VersionsByMediaType( allowMultipleLocations: false );
 
         if ( versionsOnlyByMediaType )
         {
@@ -75,9 +74,28 @@ internal HttpResponseException NewUnmatchedException(
             if ( couldMatch )
             {
                 properties ??= request.ApiVersionProperties();
-                response = properties.RequestedApiVersion is ApiVersion apiVersion
-                    ? CreateResponseForUnsupportedApiVersion( apiVersion, NotFound )
-                    : CreateNotFound( conventionRouteResult );
+
+                if ( properties.RequestedApiVersion is ApiVersion apiVersion )
+                {
+                    HttpStatusCode statusCode;
+                    var matchedUrlSegment = !string.IsNullOrEmpty( properties.RouteParameter );
+
+                    if ( matchedUrlSegment )
+                    {
+                        statusCode = NotFound;
+                    }
+                    else
+                    {
+                        var versionsByUrlOnly = options.ApiVersionReader.VersionsByUrl( allowMultipleLocations: false );
+                        statusCode = versionsByUrlOnly ? NotFound : options.UnsupportedApiVersionStatusCode;
+                    }
+
+                    response = CreateResponseForUnsupportedApiVersion( apiVersion, statusCode );
+                }
+                else
+                {
+                    response = CreateNotFound( conventionRouteResult );
+                }
             }
             else
             {