Clean up obsolete APIs in MVC

Author: captainsafia

src/Mvc/Mvc.Abstractions/src/ModelBinding/Metadata/ModelMetadataIdentity.cs

@@ -48,7 +48,7 @@ public static ModelMetadataIdentity ForType(Type modelType)
         /// <param name="name">The name of the property.</param>
         /// <param name="containerType">The container type of the model property.</param>
         /// <returns>A <see cref="ModelMetadataIdentity"/>.</returns>
-        [Obsolete("This API is obsolete and may be removed in a future release.")]
+        [Obsolete("This API is obsolete and may be removed in a future release. Please use the overload that takes a PropertyInfo object.")] // Remove after .NET 6.
         public static ModelMetadataIdentity ForProperty(
             Type modelType,
             string name,
@@ -224,7 +224,7 @@ public bool Equals(ModelMetadataIdentity other)
                 ContainerType == other.ContainerType &&
                 ModelType == other.ModelType &&
                 Name == other.Name &&
-                ParameterInfo == other.ParameterInfo && 
+                ParameterInfo == other.ParameterInfo &&
                 PropertyInfo == other.PropertyInfo &&
                 ConstructorInfo == other.ConstructorInfo;
         }

src/Mvc/Mvc.Core/src/CompatibilityVersion.cs

@@ -1,4 +1,4 @@
-// Copyright (c) .NET Foundation. All rights reserved.
+// Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
 using System;
@@ -37,14 +37,17 @@ namespace Microsoft.AspNetCore.Mvc
     /// settings to match a particular minor release of ASP.NET Core MVC.
     /// </para>
     /// </remarks>
+    // Remove after .NET 6.
+    [Obsolete("This API is obsolete and will be removed in a future version. Consider removing usages.",
+        DiagnosticId = "ASP5001",
+        UrlFormat = "https://aka.ms/aspnetcore-warnings/{0}")]
     public enum CompatibilityVersion
     {
         /// <summary>
         /// Sets the default value of settings on <see cref="MvcOptions"/> to match the behavior of
         /// ASP.NET Core MVC 2.0.
         /// </summary>
-        [Obsolete("This " + nameof(CompatibilityVersion) + " value is obsolete. The recommended alternatives are " +
-            nameof(Version_3_0) + " or later.")]
+        [Obsolete("This " + nameof(CompatibilityVersion) + " value is obsolete.")]
         Version_2_0,
 
         /// <summary>
@@ -55,8 +58,7 @@ public enum CompatibilityVersion
         /// ASP.NET Core MVC 2.1 introduced a compatibility switch for
         /// <c>MvcJsonOptions.AllowInputFormatterExceptionMessages</c>. This is now a regular property.
         /// </remarks>
-        [Obsolete("This " + nameof(CompatibilityVersion) + " value is obsolete. The recommended alternatives are " +
-            nameof(Version_3_0) + " or later.")]
+        [Obsolete("This " + nameof(CompatibilityVersion) + " value is obsolete.")]
         Version_2_1,
 
         /// <summary>
@@ -72,20 +74,21 @@ public enum CompatibilityVersion
         /// </list>
         /// All of the above are now regular properties.
         /// </remarks>
-        [Obsolete("This " + nameof(CompatibilityVersion) + " value is obsolete. The recommended alternatives are " +
-            nameof(Version_3_0) + " or later.")]
+        [Obsolete("This " + nameof(CompatibilityVersion) + " value is obsolete.")]
         Version_2_2,
 
         /// <summary>
         /// Sets the default value of settings on <see cref="MvcOptions"/> and other <c>Options</c> types to match
         /// the behavior of ASP.NET Core MVC 3.0.
         /// </summary>
+        [Obsolete("This " + nameof(CompatibilityVersion) + " value is obsolete.")]
         Version_3_0,
 
         /// <summary>
         /// Sets the default value of settings on <see cref="MvcOptions"/> to match the latest release. Use this
         /// value with care, upgrading minor versions will cause breaking changes when using <see cref="Latest"/>.
         /// </summary>
+        [Obsolete("This " + nameof(CompatibilityVersion) + " value is obsolete.")]
         Latest = int.MaxValue,
     }
 }

src/Mvc/Mvc.Core/src/DependencyInjection/MvcCoreMvcBuilderExtensions.cs

@@ -178,6 +178,9 @@ public static IMvcBuilder AddControllersAsServices(this IMvcBuilder builder)
         /// <param name="builder">The <see cref="IMvcBuilder"/>.</param>
         /// <param name="version">The <see cref="CompatibilityVersion"/> value to configure.</param>
         /// <returns>The <see cref="IMvcBuilder"/>.</returns>
+        [Obsolete("This API is obsolete and will be removed in a future version. Consider removing usages.",
+            DiagnosticId = "ASP5001",
+            UrlFormat = "https://aka.ms/aspnetcore-warnings/{0}")]
         public static IMvcBuilder SetCompatibilityVersion(this IMvcBuilder builder, CompatibilityVersion version)
         {
             if (builder == null)

src/Mvc/Mvc.Core/src/DependencyInjection/MvcCoreMvcCoreBuilderExtensions.cs

@@ -254,6 +254,9 @@ public static IMvcCoreBuilder ConfigureApiBehaviorOptions(
         /// <param name="builder">The <see cref="IMvcCoreBuilder"/>.</param>
         /// <param name="version">The <see cref="CompatibilityVersion"/> value to configure.</param>
         /// <returns>The <see cref="IMvcCoreBuilder"/>.</returns>
+        [Obsolete("This API is obsolete and will be removed in a future version. Consider removing usages.",
+            DiagnosticId = "ASP5001",
+            UrlFormat = "https://aka.ms/aspnetcore-warnings/{0}")]
         public static IMvcCoreBuilder SetCompatibilityVersion(this IMvcCoreBuilder builder, CompatibilityVersion version)
         {
             if (builder == null)

src/Mvc/Mvc.Core/src/DependencyInjection/MvcCoreServiceCollectionExtensions.cs

@@ -143,8 +143,6 @@ internal static void AddMvcCoreServices(IServiceCollection services)
             //
             services.TryAddEnumerable(
                 ServiceDescriptor.Transient<IConfigureOptions<MvcOptions>, MvcCoreMvcOptionsSetup>());
-            services.TryAddEnumerable(
-                ServiceDescriptor.Transient<IPostConfigureOptions<MvcOptions>, MvcOptionsConfigureCompatibilityOptions>());
             services.TryAddEnumerable(
                 ServiceDescriptor.Transient<IPostConfigureOptions<MvcOptions>, MvcCoreMvcOptionsSetup>());
             services.TryAddEnumerable(

src/Mvc/Mvc.Core/src/Infrastructure/ConfigureCompatibilityOptions.cs

@@ -1,4 +1,4 @@
-// Copyright (c) .NET Foundation. All rights reserved.
+// Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
 using System;
@@ -14,6 +14,9 @@ namespace Microsoft.AspNetCore.Mvc.Infrastructure
     /// by application code.
     /// </summary>
     /// <typeparam name="TOptions"></typeparam>
+    [Obsolete("This API is obsolete and will be removed in a future version. Consider removing usages.",
+        DiagnosticId = "ASP5001",
+        UrlFormat = "https://aka.ms/aspnetcore-warnings/{0}")]
     public abstract class ConfigureCompatibilityOptions<TOptions> : IPostConfigureOptions<TOptions>
         where TOptions : class, IEnumerable<ICompatibilitySwitch>
     {

src/Mvc/Mvc.Core/src/Infrastructure/MvcCompatibilityOptions.cs

@@ -1,6 +1,7 @@
-// Copyright (c) .NET Foundation. All rights reserved.
+// Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
+using System;
 using Microsoft.Extensions.DependencyInjection;
 
 namespace Microsoft.AspNetCore.Mvc.Infrastructure
@@ -13,6 +14,9 @@ namespace Microsoft.AspNetCore.Mvc.Infrastructure
     /// calling <see cref="MvcCoreMvcBuilderExtensions.SetCompatibilityVersion(IMvcBuilder, CompatibilityVersion)"/>
     /// or <see cref="MvcCoreMvcCoreBuilderExtensions.SetCompatibilityVersion(IMvcCoreBuilder, CompatibilityVersion)"/>.
     /// </remarks>
+    [Obsolete("This API is obsolete and will be removed in a future version. Consider removing usages.",
+        DiagnosticId = "ASP5001",
+        UrlFormat = "https://aka.ms/aspnetcore-warnings/{0}")]
     public class MvcCompatibilityOptions
     {
         /// <summary>

src/Mvc/Mvc.Core/src/Infrastructure/MvcOptionsConfigureCompatibilityOptions.cs

@@ -22,21 +22,6 @@ public class ObjectResultExecutor : IActionResultExecutor<ObjectResult>
     {
         private readonly AsyncEnumerableReader _asyncEnumerableReaderFactory;
 
-        /// <summary>
-        /// Creates a new <see cref="ObjectResultExecutor"/>.
-        /// </summary>
-        /// <param name="formatterSelector">The <see cref="OutputFormatterSelector"/>.</param>
-        /// <param name="writerFactory">The <see cref="IHttpResponseStreamWriterFactory"/>.</param>
-        /// <param name="loggerFactory">The <see cref="ILoggerFactory"/>.</param>
-        [Obsolete("This constructor is obsolete and will be removed in a future release.")]
-        public ObjectResultExecutor(
-            OutputFormatterSelector formatterSelector,
-            IHttpResponseStreamWriterFactory writerFactory,
-            ILoggerFactory loggerFactory)
-            : this(formatterSelector, writerFactory, loggerFactory, mvcOptions: null)
-        {
-        }
-
         /// <summary>
         /// Creates a new <see cref="ObjectResultExecutor"/>.
         /// </summary>

src/Mvc/Mvc.Core/src/Infrastructure/ObjectResultExecutor.cs

@@ -127,6 +127,7 @@ protected virtual Stream GetFileStream(string path)
                     FileOptions.Asynchronous | FileOptions.SequentialScan);
         }
 
+
         /// <summary>
         /// Get the file metadata for a path.
         /// </summary>