Clarify meaning of the group name specified in WithGroupName (#59784)

dotnet · Jan 28, 2025 · a9daf61 · a9daf61
1 parent 0aa2698
commit a9daf61
Showing 1 changed file with 3 additions and 4 deletions.
diff --git a/src/Http/Routing/src/Builder/RoutingEndpointConventionBuilderExtensions.cs b/src/Http/Routing/src/Builder/RoutingEndpointConventionBuilderExtensions.cs
@@ -112,10 +112,9 @@ public static TBuilder WithName<TBuilder>(this TBuilder builder, string endpoint
     }
 
     /// <summary>
-    /// Sets the <see cref="EndpointGroupNameAttribute"/> for all endpoints produced
-    /// on the target <see cref="IEndpointConventionBuilder"/> given the <paramref name="endpointGroupName" />.
-    /// The <see cref="IEndpointGroupNameMetadata" /> on the endpoint is used to set the endpoint's
-    /// GroupName in the OpenAPI specification.
+    /// Sets the <see cref="IEndpointGroupNameMetadata"/> with the given <paramref name="endpointGroupName"/>
+    /// in the endpoint <see cref="Http.Endpoint.Metadata"/> for all endpoints produced on the target
+    /// <see cref="IEndpointConventionBuilder"/>.
     /// </summary>
     /// <param name="builder">The <see cref="IEndpointConventionBuilder"/>.</param>
     /// <param name="endpointGroupName">The endpoint group name.</param>