Skip to content

Commit fa5a0dd

Browse files
committed
PR feedback
1 parent 4262ac9 commit fa5a0dd

File tree

2 files changed

+19
-6
lines changed

2 files changed

+19
-6
lines changed

src/Middleware/HealthChecks/src/Builder/HealthCheckEndpointRouteBuilderExtensions.cs

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,24 @@
22
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
33

44
using System;
5-
using System.Collections.Generic;
6-
using System.Text;
75
using Microsoft.AspNetCore.Builder;
8-
using Microsoft.AspNetCore.Http;
9-
using Microsoft.AspNetCore.Routing;
6+
using Microsoft.AspNetCore.Diagnostics.HealthChecks;
107
using Microsoft.Extensions.Options;
8+
using Microsoft.AspNetCore.Routing;
119

12-
namespace Microsoft.AspNetCore.Diagnostics.HealthChecks.Builder
10+
namespace Microsoft.AspNetCore.Builder
1311
{
12+
/// <summary>
13+
/// Provides extension methods for <see cref="IEndpointRouteBuilder"/> to add health checks.
14+
/// </summary>
1415
public static class HealthCheckEndpointRouteBuilderExtensions
1516
{
17+
/// <summary>
18+
/// Adds a health checks endpoint to the <see cref="IEndpointRouteBuilder"/> with the specified template.
19+
/// </summary>
20+
/// <param name="builder">The <see cref="IEndpointRouteBuilder"/> to add the health checks endpoint to.</param>
21+
/// <param name="pattern">The URL pattern of the health checks endpoint.</param>
22+
/// <returns>A convention builder for the health checks endpoint.</returns>
1623
public static IEndpointConventionBuilder MapHealthChecks(
1724
this IEndpointRouteBuilder builder,
1825
string pattern)
@@ -25,6 +32,13 @@ public static IEndpointConventionBuilder MapHealthChecks(
2532
return MapHealthChecksCore(builder, pattern, null);
2633
}
2734

35+
/// <summary>
36+
/// Adds a health checks endpoint to the <see cref="IEndpointRouteBuilder"/> with the specified template and options.
37+
/// </summary>
38+
/// <param name="builder">The <see cref="IEndpointRouteBuilder"/> to add the health checks endpoint to.</param>
39+
/// <param name="pattern">The URL pattern of the health checks endpoint.</param>
40+
/// <param name="options">A <see cref="HealthCheckOptions"/> used to configure the health checks.</param>
41+
/// <returns>A convention builder for the health checks endpoint.</returns>
2842
public static IEndpointConventionBuilder MapHealthChecks(
2943
this IEndpointRouteBuilder builder,
3044
string pattern,

src/Middleware/HealthChecks/test/UnitTests/HealthCheckEndpointRouteBuilderExtensionsTest.cs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66
using System.Net;
77
using System.Threading.Tasks;
88
using Microsoft.AspNetCore.Builder;
9-
using Microsoft.AspNetCore.Diagnostics.HealthChecks.Builder;
109
using Microsoft.AspNetCore.Hosting;
1110
using Microsoft.AspNetCore.Routing;
1211
using Microsoft.AspNetCore.TestHost;

0 commit comments

Comments
 (0)