From df5f6d1c33f81d24c48c613668dc60cd23b16966 Mon Sep 17 00:00:00 2001 From: ManickaP Date: Mon, 21 Oct 2024 16:24:35 +0200 Subject: [PATCH 1/7] Fix default value for AutomaticDecompression --- xml/System.Net.Http/WinHttpHandler.xml | 212 ++++++++++++------------- 1 file changed, 106 insertions(+), 106 deletions(-) diff --git a/xml/System.Net.Http/WinHttpHandler.xml b/xml/System.Net.Http/WinHttpHandler.xml index a97a2f67f5e..384df1b6387 100644 --- a/xml/System.Net.Http/WinHttpHandler.xml +++ b/xml/System.Net.Http/WinHttpHandler.xml @@ -36,16 +36,16 @@ Handles messages based on the WinHTTP interface of Windows. This class is intended for use in server environments. - is similar to other existing classes such as . provides a handler underneath an instance and is used to send HTTP requests out to a server and receive server responses. The implementation supports HTTP versions up to HTTP/2. - - is designed to be used primarily in server environments by ASP.NET Core and other .NET applications that communicate with HTTP servers. also provides developers with more granular control over the application's HTTP communication than the class. This allows developers to implement more advanced HTTP scenarios or modify system defaults (for example, proxy settings, timeouts, and server SSL certificate validation). - - is not intended to be a replacement for . Instead, it's a more advanced version that's provided for scenarios where is insufficient. is implemented as a thin wrapper on the WinHTTP interface of Windows and is only supported on Windows systems. - + is similar to other existing classes such as . provides a handler underneath an instance and is used to send HTTP requests out to a server and receive server responses. The implementation supports HTTP versions up to HTTP/2. + + is designed to be used primarily in server environments by ASP.NET Core and other .NET applications that communicate with HTTP servers. also provides developers with more granular control over the application's HTTP communication than the class. This allows developers to implement more advanced HTTP scenarios or modify system defaults (for example, proxy settings, timeouts, and server SSL certificate validation). + + is not intended to be a replacement for . Instead, it's a more advanced version that's provided for scenarios where is insufficient. is implemented as a thin wrapper on the WinHTTP interface of Windows and is only supported on Windows systems. + When using a chain of multiple handlers, should be at the bottom of the chain. This class is also available for use in Desktop apps by installing it as a NuGet package. For more information, see [System.Net.Http.WinHttpHandler NuGet package](https://www.nuget.org/packages/System.Net.Http.WinHttpHandler/). @@ -98,11 +98,11 @@ Starting in .NET 5, is no longer included Gets or sets the type of decompression method used by the handler for automatic decompression of the HTTP content response. To be added. - @@ -130,12 +130,12 @@ Starting in .NET 5, is no longer included to follow HTTP redirection responses; otherwise, . The default is . - @@ -187,11 +187,11 @@ When this property is set to `true`, all HTTP redirect responses from the server Gets or sets a value that indicates if the certificate is automatically picked from the certificate store or if the caller is allowed to pass in a specific client certificate. To be added. - . - + . + ]]> @@ -224,11 +224,11 @@ When this property is set to `true`, all HTTP redirect responses from the server Gets a collection of client authentication SSL certificates that are used for client authentication by the handler if the property is set to . To be added. - @@ -256,11 +256,11 @@ When this property is set to `true`, all HTTP redirect responses from the server Gets or sets the managed cookie container object. This property is only used when the property is set to UseSpecifiedCookieContainer. Otherwise, the method will throw an exception. To be added. - @@ -287,11 +287,11 @@ When this property is set to `true`, all HTTP redirect responses from the server Gets or sets a value that indicates how cookies should be managed and used. Developers can choose to ignore cookies, allow the handler to automatically manage them or manually handle them using a object. To be added. - . If this value is set to , then a container object must be initialized and assigned to the property. Otherwise, an exception will be thrown when trying to send a request. - + . If this value is set to , then a container object must be initialized and assigned to the property. Otherwise, an exception will be thrown when trying to send a request. + ]]> @@ -319,11 +319,11 @@ When this property is set to `true`, all HTTP redirect responses from the server Gets or sets the credentials used to authenticate the user to an authenticating proxy. To be added. - . - + . + ]]> @@ -412,11 +412,11 @@ When this property is set to `true`, all HTTP redirect responses from the server Gets or sets the maximum number of allowed HTTP redirects. The maximum number of allowed HTTP redirects. - is set to `true`. - + is set to `true`. + ]]> @@ -443,11 +443,11 @@ When this property is set to `true`, all HTTP redirect responses from the server Gets or sets the maximum number of TCP connections allowed to a single server. The maximum number of TCP connections allowed to a single server. - @@ -474,11 +474,11 @@ When this property is set to `true`, all HTTP redirect responses from the server Gets or sets the maximum amount of data that can be drained from responses in bytes. The maximum amount of data that can be drained from responses in bytes. - @@ -505,11 +505,11 @@ When this property is set to `true`, all HTTP redirect responses from the server Gets or sets the maximum size of the header portion from the server response in bytes. The maximum size of the header portion from the server response in bytes. - @@ -536,11 +536,11 @@ When this property is set to `true`, all HTTP redirect responses from the server Gets or sets a value that indicates whether the handler sends an Authorization header with the request. To be added. - @@ -598,11 +598,11 @@ When this property is set to `true`, all HTTP redirect responses from the server Gets or sets the custom proxy when the property is set to use a custom proxy. To be added. - @@ -629,11 +629,11 @@ When this property is set to `true`, all HTTP redirect responses from the server Gets or sets the timeout for receiving the data portion of a response from the server. The timeout for receiving the data portion of a response from the server. - @@ -660,11 +660,11 @@ When this property is set to `true`, all HTTP redirect responses from the server Gets or sets the timeout for receiving the headers of a response from the server. The timeout for receiving the headers of a response from the server. - @@ -722,11 +722,11 @@ When this property is set to `true`, all HTTP redirect responses from the server Gets or sets the timeout for sending a request. The timeout for sending a request. - @@ -760,11 +760,11 @@ When this property is set to `true`, all HTTP redirect responses from the server Gets or sets a callback method to validate the server certificate. This callback is part of the SSL handshake. The callback should return if the server certificate is considered valid and the request should be sent. Otherwise, return . - @@ -792,11 +792,11 @@ When this property is set to `true`, all HTTP redirect responses from the server Gets or sets the credentials to be used by the client to authenticate to the server. The credentials to be used by the client to authenticate to the server. - @@ -823,11 +823,11 @@ When this property is set to `true`, all HTTP redirect responses from the server Gets or sets the collection of TLS/SSL protocols supported by the client. The collection of TLS/SSL protocols supported by the client. - @@ -950,11 +950,11 @@ Only supported on Windows 10 version 2004 or newer. Gets or sets the proxy setting. This property can be set to disable the proxy, use a custom proxy, or use the proxy settings of WinHTTP or WinInet on the machine. To be added. - From 1dbfa18f32e88a16919d57bbba42f1e61861140e Mon Sep 17 00:00:00 2001 From: ManickaP Date: Mon, 21 Oct 2024 16:25:34 +0200 Subject: [PATCH 2/7] Remove non-sensical sentence from summary --- xml/System.Net.Http/WinHttpHandler.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Net.Http/WinHttpHandler.xml b/xml/System.Net.Http/WinHttpHandler.xml index 384df1b6387..dc58a8cfe52 100644 --- a/xml/System.Net.Http/WinHttpHandler.xml +++ b/xml/System.Net.Http/WinHttpHandler.xml @@ -42,7 +42,7 @@ is similar to other existing classes such as . provides a handler underneath an instance and is used to send HTTP requests out to a server and receive server responses. The implementation supports HTTP versions up to HTTP/2. - is designed to be used primarily in server environments by ASP.NET Core and other .NET applications that communicate with HTTP servers. also provides developers with more granular control over the application's HTTP communication than the class. This allows developers to implement more advanced HTTP scenarios or modify system defaults (for example, proxy settings, timeouts, and server SSL certificate validation). + provides developers with more granular control over the application's HTTP communication than the class. This allows developers to implement more advanced HTTP scenarios or modify system defaults (for example, proxy settings, timeouts, and server SSL certificate validation). is not intended to be a replacement for . Instead, it's a more advanced version that's provided for scenarios where is insufficient. is implemented as a thin wrapper on the WinHTTP interface of Windows and is only supported on Windows systems. From f36f2ff0cb448a0eafdc33aa8a00d0a162ed4a9d Mon Sep 17 00:00:00 2001 From: ManickaP Date: Mon, 4 Nov 2024 17:11:40 +0100 Subject: [PATCH 3/7] Fix MaxResponseHeadersLength --- xml/System.Net.Http/WinHttpHandler.xml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/xml/System.Net.Http/WinHttpHandler.xml b/xml/System.Net.Http/WinHttpHandler.xml index dc58a8cfe52..a564aacc8e9 100644 --- a/xml/System.Net.Http/WinHttpHandler.xml +++ b/xml/System.Net.Http/WinHttpHandler.xml @@ -502,13 +502,13 @@ When this property is set to `true`, all HTTP redirect responses from the server System.Int32 - Gets or sets the maximum size of the header portion from the server response in bytes. - The maximum size of the header portion from the server response in bytes. + Gets or sets the maximum length, in kilobytes (1024 bytes), of the response headers. + The maximum length, in kilobytes (1024 bytes), of the response headers. From 40d56692e165dff3813b11fb6cc286ea572a41c6 Mon Sep 17 00:00:00 2001 From: ManickaP Date: Wed, 6 Nov 2024 17:33:17 +0100 Subject: [PATCH 4/7] DefaultProxyCredentials --- xml/System.Net.Http/WinHttpHandler.xml | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/xml/System.Net.Http/WinHttpHandler.xml b/xml/System.Net.Http/WinHttpHandler.xml index a564aacc8e9..8cd8392fde9 100644 --- a/xml/System.Net.Http/WinHttpHandler.xml +++ b/xml/System.Net.Http/WinHttpHandler.xml @@ -316,15 +316,14 @@ When this property is set to `true`, all HTTP redirect responses from the server System.Net.ICredentials - Gets or sets the credentials used to authenticate the user to an authenticating proxy. - To be added. + When the default (system) proxy is used, gets or sets the credentials used to submit to the default proxy server for authentication. + The credentials used to authenticate the user to an authenticating proxy. . +The default proxy is used only when is set to `null`. - ]]> + ]]> From bf64f0d058477a046cba086adcc9311edb535524 Mon Sep 17 00:00:00 2001 From: ManickaP Date: Mon, 11 Nov 2024 14:54:36 +0100 Subject: [PATCH 5/7] Fix docs about ssl protocols default --- xml/System.Net.Http/WinHttpHandler.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Net.Http/WinHttpHandler.xml b/xml/System.Net.Http/WinHttpHandler.xml index 8cd8392fde9..24a757fff44 100644 --- a/xml/System.Net.Http/WinHttpHandler.xml +++ b/xml/System.Net.Http/WinHttpHandler.xml @@ -825,7 +825,7 @@ The default proxy is used only when . ]]> From 3c26ae2cf60ebb06cbe715daabe347ea90b946d5 Mon Sep 17 00:00:00 2001 From: ManickaP Date: Thu, 14 Nov 2024 10:49:26 +0100 Subject: [PATCH 6/7] Remove remarks --- xml/System.Net.Http/WinHttpHandler.xml | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/xml/System.Net.Http/WinHttpHandler.xml b/xml/System.Net.Http/WinHttpHandler.xml index 24a757fff44..0750bf1dc5e 100644 --- a/xml/System.Net.Http/WinHttpHandler.xml +++ b/xml/System.Net.Http/WinHttpHandler.xml @@ -318,13 +318,7 @@ When this property is set to `true`, all HTTP redirect responses from the server When the default (system) proxy is used, gets or sets the credentials used to submit to the default proxy server for authentication. The credentials used to authenticate the user to an authenticating proxy. - - is set to `null`. - - ]]> - + To be added. From 2e3e486140d9158a757cbc09401d26c0cf1eafc7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marie=20P=C3=ADchov=C3=A1?= <11718369+ManickaP@users.noreply.github.com> Date: Thu, 14 Nov 2024 13:46:22 +0100 Subject: [PATCH 7/7] Update xml/System.Net.Http/WinHttpHandler.xml Co-authored-by: Natalia Kondratyeva --- xml/System.Net.Http/WinHttpHandler.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Net.Http/WinHttpHandler.xml b/xml/System.Net.Http/WinHttpHandler.xml index 0750bf1dc5e..e8a4490f9fb 100644 --- a/xml/System.Net.Http/WinHttpHandler.xml +++ b/xml/System.Net.Http/WinHttpHandler.xml @@ -819,7 +819,7 @@ When this property is set to `true`, all HTTP redirect responses from the server . + The default value is `None`, which is the recommended value. It allows the operating system to choose the best protocol to use, and to block protocols that are not secure. For more information, see . ]]>