diff --git a/sdk/lib/_http/http.dart b/sdk/lib/_http/http.dart index 691f15298e9..29e785b699a 100644 --- a/sdk/lib/_http/http.dart +++ b/sdk/lib/_http/http.dart @@ -1761,9 +1761,16 @@ abstract class HttpClient { * [addCredentials] before completing the [Future] with the value * [:true:]. * - * If the [Future] completes with true the request will be retried - * using the updated credentials. Otherwise response processing will + * If the [Future] completes with [:true:] the request will be retried + * using the updated credentials, however, the retried request will not + * carry the original request payload. Otherwise response processing will * continue normally. + * + * If it is known that the remote server requires authentication for all + * requests, it is advisable to use [addCredentials] directly, or manually + * set the `'authorization'` header on the request to avoid the overhead + * of a failed request, or issues due to missing request payload on retried + * request. */ set authenticate(Future f(Uri url, String scheme, String realm));