Clarify HttpRetryStrategyOptions/HttpHedgingStrategyOptions XML doc (#…

…5445) * Update HttpRetryStrategyOptions XML doc * Update HttpHedgingStrategyOptions XML doc * Update HttpHedgingStrategyOptions.cs * Update HttpRetryStrategyOptions.cs
dotnet · Sep 26, 2024 · 5dc6476 · 5dc6476
1 parent c799d76
commit 5dc6476
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 4 deletions.
diff --git a/src/Libraries/Microsoft.Extensions.Http.Resilience/Hedging/HttpHedgingStrategyOptions.cs b/src/Libraries/Microsoft.Extensions.Http.Resilience/Hedging/HttpHedgingStrategyOptions.cs
@@ -3,7 +3,9 @@
 
 using System.Net.Http;
 using System.Threading.Tasks;
+using Polly.CircuitBreaker;
 using Polly.Hedging;
+using Polly.Timeout;
 
 namespace Microsoft.Extensions.Http.Resilience;
 
@@ -16,8 +18,9 @@ public class HttpHedgingStrategyOptions : HedgingStrategyOptions<HttpResponseMes
     /// Initializes a new instance of the <see cref="HttpHedgingStrategyOptions"/> class.
     /// </summary>
     /// <remarks>
-    /// By default, the options are set to handle only transient failures,
-    /// that is, timeouts, 5xx responses, and <see cref="HttpRequestException"/> exceptions.
+    /// By default, the options are configured to handle only transient failures.
+    /// Specifically, this includes HTTP status codes 408, 429, 500 and above, 
+    /// as well as <see cref="HttpRequestException"/>, <see cref="BrokenCircuitException"/>, and <see cref="TimeoutRejectedException"/> exceptions.
     /// </remarks>
     public HttpHedgingStrategyOptions()
     {

diff --git a/src/Libraries/Microsoft.Extensions.Http.Resilience/Polly/HttpRetryStrategyOptions.cs b/src/Libraries/Microsoft.Extensions.Http.Resilience/Polly/HttpRetryStrategyOptions.cs
@@ -7,6 +7,7 @@
 using Microsoft.Extensions.Http.Resilience.Internal;
 using Polly;
 using Polly.Retry;
+using Polly.Timeout;
 
 namespace Microsoft.Extensions.Http.Resilience;
 
@@ -21,8 +22,9 @@ public class HttpRetryStrategyOptions : RetryStrategyOptions<HttpResponseMessage
     /// Initializes a new instance of the <see cref="HttpRetryStrategyOptions"/> class.
     /// </summary>
     /// <remarks>
-    /// By default, the options are set to handle only transient failures,
-    /// that is, timeouts, 5xx responses, and <see cref="HttpRequestException"/> exceptions.
+    /// By default, the options are configured to handle only transient failures.
+    /// Specifically, this includes HTTP status codes 408, 429, 500 and above, 
+    /// as well as <see cref="HttpRequestException"/> and <see cref="TimeoutRejectedException"/> exceptions.
     /// </remarks>
     public HttpRetryStrategyOptions()
     {