Prefix new types with 'Endpoint'

Author: captainsafia

src/Http/Http.Abstractions/src/Metadata/IDescriptionMetadata.cs

@@ -6,7 +6,7 @@ namespace Microsoft.AspNetCore.Http.Metadata;
 /// <summary>
 /// Defines a contract used to specify a description in <see cref="Endpoint.Metadata"/>.
 /// </summary>
-public interface IDescriptionMetadata
+public interface IEndpointDescriptionMetadata
 {
     /// <summary>
     /// Gets the description associated with the endpoint.

src/Http/Http.Abstractions/src/Metadata/ISummaryMetadata.cs

@@ -6,7 +6,7 @@ namespace Microsoft.AspNetCore.Http.Metadata;
 /// <summary>
 /// Defines a contract used to specify a summary in <see cref="Endpoint.Metadata"/>.
 /// </summary>
-public interface ISummaryMetadata
+public interface IEndpointSummaryMetadata
 {
     /// <summary>
     /// Gets the summary associated with the endpoint.

src/Http/Http.Abstractions/src/PublicAPI.Unshipped.txt

@@ -4,7 +4,7 @@ Microsoft.AspNetCore.Http.Metadata.IFromFormMetadata
 Microsoft.AspNetCore.Http.Metadata.IFromFormMetadata.Name.get -> string?
 abstract Microsoft.AspNetCore.Http.HttpResponse.ContentType.get -> string?
 Microsoft.AspNetCore.Http.Metadata.ISkipStatusCodePagesMetadata
-Microsoft.AspNetCore.Http.Metadata.IDescriptionMetadata
-Microsoft.AspNetCore.Http.Metadata.IDescriptionMetadata.Description.get -> string!
-Microsoft.AspNetCore.Http.Metadata.ISummaryMetadata
-Microsoft.AspNetCore.Http.Metadata.ISummaryMetadata.Summary.get -> string!
+Microsoft.AspNetCore.Http.Metadata.IEndpointDescriptionMetadata
+Microsoft.AspNetCore.Http.Metadata.IEndpointDescriptionMetadata.Description.get -> string!
+Microsoft.AspNetCore.Http.Metadata.IEndpointSummaryMetadata
+Microsoft.AspNetCore.Http.Metadata.IEndpointSummaryMetadata.Summary.get -> string!

src/Http/Http.Extensions/src/DescriptionAttribute.cs renamed to src/Http/Http.Extensions/src/EndpointDescriptionAttribute.cs

@@ -14,13 +14,13 @@ namespace Microsoft.AspNetCore.Http;
 /// behavior.
 /// </remarks>
 [AttributeUsage(AttributeTargets.Method | AttributeTargets.Delegate, Inherited = false, AllowMultiple = false)]
-public sealed class DescriptionAttribute : Attribute, IDescriptionMetadata
+public sealed class EndpointDescriptionAttribute : Attribute, IEndpointDescriptionMetadata
 {
     /// <summary>
-    /// Initializes an instance of the <see cref="DescriptionAttribute"/>.
+    /// Initializes an instance of the <see cref="EndpointDescriptionAttribute"/>.
     /// </summary>
     /// <param name="description">The description associated with the endpoint or parameter.</param>
-    public DescriptionAttribute(string description)
+    public EndpointDescriptionAttribute(string description)
     {
         Description = description;
     }

src/Http/Http.Extensions/src/SummaryAttribute.cs renamed to src/Http/Http.Extensions/src/EndpointSummaryAttribute.cs

@@ -9,13 +9,13 @@ namespace Microsoft.AspNetCore.Http;
 /// Specifies a summary in <see cref="Endpoint.Metadata"/>.
 /// </summary>
 [AttributeUsage(AttributeTargets.Method | AttributeTargets.Delegate, Inherited = false, AllowMultiple = false)]
-public sealed class SummaryAttribute : Attribute, ISummaryMetadata
+public sealed class EndpointSummaryAttribute : Attribute, IEndpointSummaryMetadata
 {
     /// <summary>
-    /// Initializes an instance of the <see cref="SummaryAttribute"/>.
+    /// Initializes an instance of the <see cref="EndpointSummaryAttribute"/>.
     /// </summary>
     /// <param name="summary">The summary associated with the endpoint or parameter.</param>
-    public SummaryAttribute(string summary)
+    public EndpointSummaryAttribute(string summary)
     {
         Summary = summary;
     }

src/Http/Http.Extensions/src/PublicAPI.Unshipped.txt

@@ -1,9 +1,9 @@
 #nullable enable
 Microsoft.Extensions.DependencyInjection.RouteHandlerJsonServiceExtensions
 static Microsoft.Extensions.DependencyInjection.RouteHandlerJsonServiceExtensions.ConfigureRouteHandlerJsonOptions(this Microsoft.Extensions.DependencyInjection.IServiceCollection! services, System.Action<Microsoft.AspNetCore.Http.Json.JsonOptions!>! configureOptions) -> Microsoft.Extensions.DependencyInjection.IServiceCollection!
-Microsoft.AspNetCore.Http.DescriptionAttribute
-Microsoft.AspNetCore.Http.DescriptionAttribute.DescriptionAttribute(string! description) -> void
-Microsoft.AspNetCore.Http.DescriptionAttribute.Description.get -> string!
-Microsoft.AspNetCore.Http.SummaryAttribute
-Microsoft.AspNetCore.Http.SummaryAttribute.SummaryAttribute(string! summary) -> void
-Microsoft.AspNetCore.Http.SummaryAttribute.Summary.get -> string!
+Microsoft.AspNetCore.Http.EndpointDescriptionAttribute
+Microsoft.AspNetCore.Http.EndpointDescriptionAttribute.EndpointDescriptionAttribute(string! description) -> void
+Microsoft.AspNetCore.Http.EndpointDescriptionAttribute.Description.get -> string!
+Microsoft.AspNetCore.Http.EndpointSummaryAttribute
+Microsoft.AspNetCore.Http.EndpointSummaryAttribute.EndpointSummaryAttribute(string! summary) -> void
+Microsoft.AspNetCore.Http.EndpointSummaryAttribute.Summary.get -> string!

src/Http/Routing/src/Builder/OpenApiRouteHandlerBuilderExtensions.cs

@@ -210,28 +210,28 @@ public static RouteHandlerBuilder Accepts(this RouteHandlerBuilder builder,
     }
 
     /// <summary>
-    /// Adds <see cref="IDescriptionMetadata"/> to <see cref="EndpointBuilder.Metadata"/> for all builders
+    /// Adds <see cref="IEndpointDescriptionMetadata"/> to <see cref="EndpointBuilder.Metadata"/> for all builders
     /// produced by <paramref name="builder"/>.
     /// </summary>
     /// <param name="builder">The <see cref="RouteHandlerBuilder"/>.</param>
     /// <param name="description">A string representing a detailed description of the endpoint.</param>
     /// <returns>A <see cref="RouteHandlerBuilder"/> that can be used to further customize the endpoint.</returns>
     public static RouteHandlerBuilder WithDescription(this RouteHandlerBuilder builder, string description)
     {
-        builder.WithMetadata(new DescriptionAttribute(description));
+        builder.WithMetadata(new EndpointDescriptionAttribute(description));
         return builder;
     }
 
     /// <summary>
-    /// Adds <see cref="ISummaryMetadata"/> to <see cref="EndpointBuilder.Metadata"/> for all builders
+    /// Adds <see cref="IEndpointSummaryMetadata"/> to <see cref="EndpointBuilder.Metadata"/> for all builders
     /// produced by <paramref name="builder"/>.
     /// </summary>
     /// <param name="builder">The <see cref="RouteHandlerBuilder"/>.</param>
     /// <param name="summary">A string representation a brief description of the endpoint.</param>
     /// <returns>A <see cref="RouteHandlerBuilder"/> that can be used to further customize the endpoint.</returns>
     public static RouteHandlerBuilder WithSummary(this RouteHandlerBuilder builder, string summary)
     {
-        builder.WithMetadata(new SummaryAttribute(summary));
+        builder.WithMetadata(new EndpointSummaryAttribute(summary));
         return builder;
     }
 

src/Mvc/Mvc.ApiExplorer/test/EndpointMetadataApiDescriptionProviderTest.cs

@@ -513,7 +513,7 @@ public void TestParameterIsRequiredForObliviousNullabilityContext()
     [Fact]
     public void TestParameterAttributesCanBeInspected()
     {
-        var apiDescription = GetApiDescription(([System.ComponentModel.Description("The name.")] string name) => { });
+        var apiDescription = GetApiDescription(([Description("The name.")] string name) => { });
         Assert.Equal(1, apiDescription.ParameterDescriptions.Count);
 
         var nameParam = apiDescription.ParameterDescriptions[0];
@@ -530,7 +530,7 @@ public void TestParameterAttributesCanBeInspected()
 
         Assert.NotNull(descriptor.ParameterInfo);
 
-        var description = Assert.Single(descriptor.ParameterInfo.GetCustomAttributes<System.ComponentModel.DescriptionAttribute>());
+        var description = Assert.Single(descriptor.ParameterInfo.GetCustomAttributes<DescriptionAttribute>());
 
         Assert.NotNull(description);
         Assert.Equal("The name.", description.Description);
@@ -1168,11 +1168,11 @@ public void HandlesEndpointWithDescriptionAndSummary_WithExtensionMethods()
         var apiDescription = Assert.Single(context.Results);
         Assert.NotEmpty(apiDescription.ActionDescriptor.EndpointMetadata);
 
-        var descriptionMetadata = apiDescription.ActionDescriptor.EndpointMetadata.OfType<IDescriptionMetadata>().SingleOrDefault();
+        var descriptionMetadata = apiDescription.ActionDescriptor.EndpointMetadata.OfType<IEndpointDescriptionMetadata>().SingleOrDefault();
         Assert.NotNull(descriptionMetadata);
         Assert.Equal("A description", descriptionMetadata.Description);
 
-        var summaryMetadata = apiDescription.ActionDescriptor.EndpointMetadata.OfType<ISummaryMetadata>().SingleOrDefault();
+        var summaryMetadata = apiDescription.ActionDescriptor.EndpointMetadata.OfType<IEndpointSummaryMetadata>().SingleOrDefault();
         Assert.NotNull(summaryMetadata);
         Assert.Equal("A summary", summaryMetadata.Summary);
     }
@@ -1181,7 +1181,7 @@ public void HandlesEndpointWithDescriptionAndSummary_WithExtensionMethods()
     public void HandlesEndpointWithDescriptionAndSummary_WithAttributes()
     {
         var builder = CreateBuilder();
-        builder.MapGet("/api/todos/{id}", [Summary("A summary")][Http.Description("A description")] (int id) => "");
+        builder.MapGet("/api/todos/{id}", [EndpointSummary("A summary")][EndpointDescription("A description")] (int id) => "");
 
         var context = new ApiDescriptionProviderContext(Array.Empty<ActionDescriptor>());
 
@@ -1199,11 +1199,11 @@ public void HandlesEndpointWithDescriptionAndSummary_WithAttributes()
         var apiDescription = Assert.Single(context.Results);
         Assert.NotEmpty(apiDescription.ActionDescriptor.EndpointMetadata);
 
-        var descriptionMetadata = apiDescription.ActionDescriptor.EndpointMetadata.OfType<IDescriptionMetadata>().SingleOrDefault();
+        var descriptionMetadata = apiDescription.ActionDescriptor.EndpointMetadata.OfType<IEndpointDescriptionMetadata>().SingleOrDefault();
         Assert.NotNull(descriptionMetadata);
         Assert.Equal("A description", descriptionMetadata.Description);
 
-        var summaryMetadata = apiDescription.ActionDescriptor.EndpointMetadata.OfType<ISummaryMetadata>().SingleOrDefault();
+        var summaryMetadata = apiDescription.ActionDescriptor.EndpointMetadata.OfType<IEndpointSummaryMetadata>().SingleOrDefault();
         Assert.NotNull(summaryMetadata);
         Assert.Equal("A summary", summaryMetadata.Summary);
     }