Merge branch 'main' into merge

xavierjohn · web-flow · commit 987e65ac75ac · 2025-11-18T12:05:35.000-08:00
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -4,7 +4,7 @@
 
 <!-- If this is your first PR in the ASP.NET API Versioning repo, please run through the checklist below to ensure a smooth review and merge process for your PR. -->
 
-- [ ] You've read the [Contributor Guide](https://github.com/dotnet/aspnet-api-versioning/blob/main/CONTRIBUTING.md) and [Code of Conduct](https://dotnetfoundation.org/code-of-conduct).
+- [ ] You've read the [Contributor Guide](https://github.com/dotnet/aspnet-api-versioning/blob/main/docs/CONTRIBUTING.md) and [Code of Conduct](https://dotnetfoundation.org/code-of-conduct).
 - [ ] You've included unit or integration tests for your change, where applicable.
 - [ ] You've included inline docs for your change, where applicable.
 - [ ] There's an open issue for the PR that you are making. If you'd like to propose a new feature or change, please open an issue to discuss the change or find an existing issue.
diff --git a/examples/AspNetCore/OData/Directory.Build.props b/examples/AspNetCore/OData/Directory.Build.props
@@ -4,7 +4,7 @@
  <Import Project="$([MSBuild]::GetPathOfFileAbove('$(MSBuildThisFile)','$(MSBuildThisFileDirectory)../'))" />
 
  <ItemGroup>
-  <PackageReference Include="Microsoft.AspNetCore.OData" Version="8.2.3" />
+  <PackageReference Include="Microsoft.AspNetCore.OData" Version="9.2.1" />
  </ItemGroup>
 
 </Project>
diff --git a/src/AspNetCore/Acceptance/Asp.Versioning.Mvc.Acceptance.Tests/OData/Basic/given a versioned ODataController/when using a query string.cs b/src/AspNetCore/Acceptance/Asp.Versioning.Mvc.Acceptance.Tests/OData/Basic/given a versioned ODataController/when using a query string.cs
@@ -49,6 +49,7 @@ public async Task then_get_should_return_400_for_an_unspecified_version()
         // assert
         response.StatusCode.Should().Be( BadRequest );
         problem.Type.Should().Be( ProblemDetailsDefaults.Unspecified.Type );
+        problem.Extensions["code"].ToString().Should().Be( "ApiVersionUnspecified" );
     }
 
     public when_using_a_query_string( BasicFixture fixture, ITestOutputHelper console )
diff --git a/src/AspNetCore/OData/src/Asp.Versioning.OData.ApiExplorer/Asp.Versioning.OData.ApiExplorer.csproj b/src/AspNetCore/OData/src/Asp.Versioning.OData.ApiExplorer/Asp.Versioning.OData.ApiExplorer.csproj
@@ -1,8 +1,8 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
 
  <PropertyGroup>
-  <VersionPrefix>8.1.0</VersionPrefix>
-  <AssemblyVersion>8.1.0.0</AssemblyVersion>
+  <VersionPrefix>8.2.0</VersionPrefix>
+  <AssemblyVersion>8.2.0.0</AssemblyVersion>
   <TargetFramework>$(DefaultTargetFramework)</TargetFramework>
   <RootNamespace>Asp.Versioning</RootNamespace>
   <AssemblyTitle>ASP.NET Core API Versioning API Explorer for OData v4.0</AssemblyTitle>
diff --git a/src/AspNetCore/OData/src/Asp.Versioning.OData.ApiExplorer/ReleaseNotes.txt b/src/AspNetCore/OData/src/Asp.Versioning.OData.ApiExplorer/ReleaseNotes.txt
@@ -1 +1 @@
-﻿
+﻿Support OData 9.0 ([#1103](https://github.com/dotnet/aspnet-api-versioning/issues/1103))
diff --git a/src/AspNetCore/OData/src/Asp.Versioning.OData/Asp.Versioning.OData.csproj b/src/AspNetCore/OData/src/Asp.Versioning.OData/Asp.Versioning.OData.csproj
@@ -1,8 +1,8 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
 
  <PropertyGroup>
-  <VersionPrefix>8.1.0</VersionPrefix>
-  <AssemblyVersion>8.1.0.0</AssemblyVersion>
+  <VersionPrefix>8.2.0</VersionPrefix>
+  <AssemblyVersion>8.2.0.0</AssemblyVersion>
   <TargetFramework>$(DefaultTargetFramework)</TargetFramework>
   <RootNamespace>Asp.Versioning</RootNamespace>
   <AssemblyTitle>ASP.NET Core API Versioning with OData v4.0</AssemblyTitle>
@@ -15,7 +15,7 @@
  </ItemGroup>
 
  <ItemGroup>
-  <PackageReference Include="Microsoft.AspNetCore.OData" Version="[8.0.2,9.0.0)" />
+  <PackageReference Include="Microsoft.AspNetCore.OData" Version="[8.0.2,10.0.0)" />
  </ItemGroup>
 
  <ItemGroup>
diff --git a/src/AspNetCore/OData/src/Asp.Versioning.OData/OData/ODataApplicationModelProvider.cs b/src/AspNetCore/OData/src/Asp.Versioning.OData/OData/ODataApplicationModelProvider.cs
@@ -141,7 +141,7 @@ private static
         return (metadataControllers, supported, deprecated);
     }
 
-    private static ControllerModel? SelectBestMetadataController( ControllerModel[] controllers )
+    private static ControllerModel? SelectBestMetadataController( List<ControllerModel> controllers )
     {
         // note: there should be at least 2 metadata controllers, but there could be 3+
         // if a developer defines their own custom controller. ultimately, there can be
diff --git a/src/AspNetCore/OData/src/Asp.Versioning.OData/ReleaseNotes.txt b/src/AspNetCore/OData/src/Asp.Versioning.OData/ReleaseNotes.txt
@@ -1 +1 @@
-﻿
+﻿Support OData 9.0 ([#1103](https://github.com/dotnet/aspnet-api-versioning/issues/1103))
diff --git a/src/AspNetCore/WebApi/src/Asp.Versioning.Http/Routing/EndpointProblem.cs b/src/AspNetCore/WebApi/src/Asp.Versioning.Http/Routing/EndpointProblem.cs
@@ -25,7 +25,7 @@ internal static ProblemDetailsContext New( HttpContext context, ProblemDetailsIn
             },
         };
 
-        if ( string.IsNullOrEmpty( code ) )
+        if ( !string.IsNullOrEmpty( code ) )
         {
             newContext.ProblemDetails.Extensions[nameof( code )] = code;
         }
diff --git a/src/AspNetCore/WebApi/src/Asp.Versioning.Mvc/ApplicationModels/DefaultApiControllerFilter.cs b/src/AspNetCore/WebApi/src/Asp.Versioning.Mvc/ApplicationModels/DefaultApiControllerFilter.cs
@@ -10,7 +10,7 @@ namespace Asp.Versioning.ApplicationModels;
 [CLSCompliant( false )]
 public sealed class DefaultApiControllerFilter : IApiControllerFilter
 {
-    private readonly IApiControllerSpecification[] specifications;
+    private readonly List<IApiControllerSpecification> specifications;
 
     /// <summary>
     /// Initializes a new instance of the <see cref="DefaultApiControllerFilter"/> class.
@@ -19,7 +19,7 @@ public sealed class DefaultApiControllerFilter : IApiControllerFilter
     /// <see cref="IApiControllerSpecification">specifications</see> used by the filter
     /// to identify API controllers.</param>
     public DefaultApiControllerFilter( IEnumerable<IApiControllerSpecification> specifications ) =>
-        this.specifications = specifications.ToArray();
+        this.specifications = specifications.ToList();
 
     /// <inheritdoc />
     public IList<ControllerModel> Apply( IList<ControllerModel> controllers )
diff --git a/src/Common/src/Common.OData.ApiExplorer/Conventions/ODataAttributeVisitor.cs b/src/Common/src/Common.OData.ApiExplorer/Conventions/ODataAttributeVisitor.cs
@@ -76,7 +76,7 @@ private void VisitModel( IEdmStructuredType modelType )
         VisitMaxTop( querySettings );
     }
 
-    private void VisitEnableQuery(EnableQueryAttribute[] attributes )
+    private void VisitEnableQuery( EnableQueryAttribute[] attributes )
     {
         var @default = new EnableQueryAttribute();
 
diff --git a/src/Common/src/Common.OData.ApiExplorer/OData/DefaultModelTypeBuilder.cs b/src/Common/src/Common.OData.ApiExplorer/OData/DefaultModelTypeBuilder.cs
@@ -417,7 +417,11 @@ private static PropertyBuilder AddProperty(
         var field = addTo.DefineField( "_" + name, shouldBeAdded, FieldAttributes.Private );
         var propertyBuilder = addTo.DefineProperty( name, PropertyAttributes.HasDefault, shouldBeAdded, null );
         var getter = addTo.DefineMethod( "get_" + name, propertyMethodAttributes, shouldBeAdded, Type.EmptyTypes );
-        var setter = addTo.DefineMethod( "set_" + name, propertyMethodAttributes, shouldBeAdded, Type.EmptyTypes );
+
+        /* returnType is 'null' instead of type(void) as per docs
+        * see: https://learn.microsoft.com/en-us/dotnet/api/system.reflection.emit.propertybuilder?view=net-9.0
+        */
+        var setter = addTo.DefineMethod( "set_" + name, propertyMethodAttributes, null, [shouldBeAdded] );
         var il = getter.GetILGenerator();
 
         il.Emit( OpCodes.Ldarg_0 );
diff --git a/src/Common/src/Common/ApiVersioningOptions.cs b/src/Common/src/Common/ApiVersioningOptions.cs
@@ -59,14 +59,16 @@ public partial class ApiVersioningOptions
     /// <summary>
     /// Gets or sets the API version reader.
     /// </summary>
-    /// <value>An <see cref="IApiVersionReader">API version reader</see> object. The default value
-    /// is an instance of the <see cref="QueryStringApiVersionReader"/>.</value>
-    /// <remarks>The <see cref="IApiVersionReader">API version reader</see> is used to read the
-    /// API version specified by a client. The default value is the
-    /// <see cref="QueryStringApiVersionReader"/>, which only reads the API version from
-    /// the "api-version" query string parameter. Replace the default value with an alternate
-    /// implementation, such as the <see cref="HeaderApiVersionReader"/>, which
-    /// can read the API version from additional information like HTTP headers.</remarks>
+    /// <value>An <see cref="IApiVersionReader">API version reader</see> object. The default value is a combined reader
+    /// with both <see cref="QueryStringApiVersionReader"/> and <see cref="UrlSegmentApiVersionReader"/>.</value>
+    /// <remarks>
+    /// The <see cref="IApiVersionReader">API version reader</see> is used to read the API version specified by a
+    /// client. The default value consist of both <see cref="QueryStringApiVersionReader"/> and
+    /// <see cref="UrlSegmentApiVersionReader"/>, which reads the API version from the "api-version" query string
+    /// parameter and a path segment in the request URL respectively.
+    /// Replace the default value with an alternate implementation, such as the <see cref="HeaderApiVersionReader"/>,
+    /// which can read the API version from additional information like HTTP headers.
+    /// </remarks>
 #if !NETFRAMEWORK
     [CLSCompliant( false )]
 #endif
diff --git a/src/Common/src/Common/HeaderApiVersionReader.cs b/src/Common/src/Common/HeaderApiVersionReader.cs
@@ -15,6 +15,10 @@ public partial class HeaderApiVersionReader : IApiVersionReader
     /// <summary>
     /// Initializes a new instance of the <see cref="HeaderApiVersionReader"/> class.
     /// </summary>
+    /// <remarks>
+    /// There is no default header. Either initialize headers using the <see cref="HeaderNames"/> collection property,
+    /// or call a constructor that  accepts header names. Otherwise, this reader has no effect.
+    /// </remarks>
     public HeaderApiVersionReader() { }
 
     /// <summary>
diff --git a/src/Common/test/Common.Acceptance.Tests/HttpContentExtensions.cs b/src/Common/test/Common.Acceptance.Tests/HttpContentExtensions.cs
@@ -6,20 +6,30 @@ namespace Asp.Versioning;
 using Microsoft.AspNetCore.Mvc;
 #endif
 using System.Net.Http;
+#if NETFRAMEWORK
 using System.Net.Http.Formatting;
+#else
+using System.Net.Http.Json;
+#endif
 
 internal static class HttpContentExtensions
 {
+#if NETFRAMEWORK
     private static readonly JsonMediaTypeFormatter ProblemDetailsMediaTypeFormatter = new()
     {
         SupportedMediaTypes = { new( ProblemDetailsDefaults.MediaType.Json ) },
     };
     private static readonly IEnumerable<MediaTypeFormatter> MediaTypeFormatters = new[] { ProblemDetailsMediaTypeFormatter };
+#endif
 
     public static Task<ProblemDetails> ReadAsProblemDetailsAsync(
         this HttpContent content,
         CancellationToken cancellationToken = default ) =>
+#if NETFRAMEWORK
         content.ReadAsAsync<ProblemDetails>( MediaTypeFormatters, cancellationToken );
+#else
+        content.ReadFromJsonAsync<ProblemDetails>( cancellationToken );
+#endif
 
 #pragma warning disable IDE0060 // Remove unused parameter
 #pragma warning disable IDE0079 // Remove unnecessary suppression
diff --git a/src/Common/test/Common.OData.ApiExplorer.Tests/OData/DefaultModelTypeBuilderTest.cs b/src/Common/test/Common.OData.ApiExplorer.Tests/OData/DefaultModelTypeBuilderTest.cs
@@ -409,6 +409,41 @@ public void substitute_should_resolve_types_that_reference_a_model_that_match_th
         substitutionType.Should().NotBeOfType<TypeBuilder>();
     }
 
+    [Fact]
+    public void substituted_type_should_have_valid_runtime_properties__issue1104()
+    {
+        // arrange
+        var modelBuilder = new ODataConventionModelBuilder();
+
+        var address = modelBuilder.EntitySet<Address>( nameof( Address ) ).EntityType;
+        address.Ignore( x => x.City ); // force substitution
+        var addressType = typeof( Address );
+
+        var context = NewContext( modelBuilder.GetEdmModel() );
+
+        // act
+        var substitutedType = addressType.SubstituteIfNecessary( context );
+
+        // assert
+        substitutedType.Should().NotBe( addressType );
+#if NET452
+        substitutedType.GetRuntimeProperties().Should().HaveCount( 5 );
+        foreach ( var substitutedProperty in substitutedType.GetRuntimeProperties() )
+        {
+            substitutedProperty.Should().NotBeNull();
+            substitutedProperty.GetSetMethod( true ).Should().NotBeNull()
+                .And.Match( p => p.ReturnType == typeof( void ) )
+                .And.Match( p => p.GetParameters().Length == 1 );
+        }
+#else
+        substitutedType.GetRuntimeProperties().Should().HaveCount( 5 )
+            .And.AllSatisfy( prop => prop.GetSetMethod( true ).Should()
+                .NotBeNull()
+                .And.ReturnVoid()
+                .And.Match( setter => setter.GetParameters().Length == 1 ) );
+#endif
+    }
+
     public static IEnumerable<object[]> SubstitutionNotRequiredData
     {
         get

Original file line number	Diff line number	Diff line change
`@@ -49,6 +49,7 @@ public async Task then_get_should_return_400_for_an_unspecified_version()`
`49`	`49`	`// assert`
`50`	`50`	`response.StatusCode.Should().Be( BadRequest );`
`51`	`51`	`problem.Type.Should().Be( ProblemDetailsDefaults.Unspecified.Type );`
	`52`	`+ problem.Extensions["code"].ToString().Should().Be( "ApiVersionUnspecified" );`
`52`	`53`	`}`
`53`	`54`
`54`	`55`	`public when_using_a_query_string( BasicFixture fixture, ITestOutputHelper console )`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-`
	`1`	`+Support OData 9.0 ([#1103](https://github.com/dotnet/aspnet-api-versioning/issues/1103))`
Original file line number	Diff line number	Diff line change
`@@ -141,7 +141,7 @@ private static`
`141`	`141`	`return (metadataControllers, supported, deprecated);`
`142`	`142`	`}`
`143`	`143`
`144`		`- private static ControllerModel? SelectBestMetadataController( ControllerModel[] controllers )`
	`144`	`+ private static ControllerModel? SelectBestMetadataController( List<ControllerModel> controllers )`
`145`	`145`	`{`
`146`	`146`	`// note: there should be at least 2 metadata controllers, but there could be 3+`
`147`	`147`	`// if a developer defines their own custom controller. ultimately, there can be`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ internal static ProblemDetailsContext New( HttpContext context, ProblemDetailsIn`
`25`	`25`	`},`
`26`	`26`	`};`
`27`	`27`
`28`		`- if ( string.IsNullOrEmpty( code ) )`
	`28`	`+ if ( !string.IsNullOrEmpty( code ) )`
`29`	`29`	`{`
`30`	`30`	`newContext.ProblemDetails.Extensions[nameof( code )] = code;`
`31`	`31`	`}`