HTTP Version Selection #4870

aik-jahoda · 2020-09-17T13:09:34Z

Summary

Documentation of dotnet/runtime#39201

xml/System.Net.Http/HttpClient.xml

xml/System.Net.Http/HttpRequestMessage.xml

xml/System.Net.Http/HttpVersionPolicy.xml

gewarren · 2020-09-17T17:18:44Z

xml/System.Net.Http/HttpVersionPolicy.xml

@@ -34,7 +34,15 @@
      </ReturnValue>
      <MemberValue>2</MemberValue>
      <Docs>
-        <summary>To be added.</summary>
+        <summary>Uses only the requested version. Throwing <see cref="HttpRequestException" /> if a connection with the exact version cannot be established.</summary>


Suggested change

<summary>Uses only the requested version. Throwing <see cref="HttpRequestException" /> if a connection with the exact version cannot be established.</summary>

<summary>Only use the requested version.</summary>

Question: Which method(s) would throw that exception? We should include that here, or a general description of those methods, because the enum member doesn't throw it.

SocketsHttpHandler send methods since the property (HttpRequestMessage.VersionPolicy) is interpreted there. This also influences the behavior of HttpClient if it's used with default handlers. OTOH, it has no effect on WinHttpHandler for instance.

The HttpClient has a HttpRequestException exception mentioned but in general way. On other side this description is very specific for SocketsHttpHandler and this policy.

I would leave it like it is or delete it from the HttpVersionPolicy.xml as the reason why it can be thrown is quite obvious.

@gewarren, what is your opinion there?

I think just remove that part of the sentence. I'll edit my suggestion to reflect that.

xml/System.Net.Http/HttpVersionPolicy.xml

xml/System.Net.Http/HttpClient.xml

ManickaP

Content-wise LGTM.
Thank you!

gewarren · 2020-09-18T21:39:03Z

Oops!

Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>

opbld34 · 2020-09-21T14:16:45Z

Docs Build status updates of commit 6c467aa:

⚠️ Validation status: warnings

File	Status	Preview URL	Details
xml/System.Net.Http/HttpVersionPolicy.xml	⚠️Warning	View	Details
xml/System.Net.Http/HttpClient.xml	✅Succeeded	View
xml/System.Net.Http/HttpRequestMessage.xml	✅Succeeded	View

xml/System.Net.Http/HttpVersionPolicy.xml

Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'HttpRequestException'.
Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'HttpRequestException'.

For more details, please refer to the build report.

If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Docs Build.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

Note: Your PR may contain errors or warnings unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

Try searching in the Docs contributor and Admin Guide
See the frequently asked questions
Post your question in the Docs support channel

xml/System.Net.Http/HttpClient.xml

xml/System.Net.Http/HttpRequestMessage.xml

xml/System.Net.Http/HttpVersionPolicy.xml

pgovind · 2020-09-21T17:49:42Z

xml/System.Net.Http/HttpVersionPolicy.xml

@@ -54,7 +62,17 @@
      </ReturnValue>
      <MemberValue>1</MemberValue>
      <Docs>
-        <summary>To be added.</summary>
+        <summary>Use the highest available version, downgrading only to the requested version but not below. Throws an <see cref="HttpRequestException" /> if a connection with higher or equal version cannot be established.</summary>


Same here with exception

xml/System.Net.Http/HttpVersionPolicy.xml

Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>

opbld30 · 2020-09-22T20:12:42Z

Docs Build status updates of commit 7236a37:

✅ Validation status: passed

File	Status	Preview URL
xml/System.Net.Http/HttpClient.xml	✅Succeeded	View
xml/System.Net.Http/HttpRequestMessage.xml	✅Succeeded	View
xml/System.Net.Http/HttpVersionPolicy.xml	✅Succeeded	View

For more details, please refer to the build report.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

For any questions, please:

Try searching in the Docs contributor and Admin Guide
See the frequently asked questions
Post your question in the Docs support channel

opbld31 · 2020-09-22T20:35:28Z

Docs Build status updates of commit f9f5151:

✅ Validation status: passed

File	Status	Preview URL
xml/System.Net.Http/HttpClient.xml	✅Succeeded	View
xml/System.Net.Http/HttpRequestMessage.xml	✅Succeeded	View
xml/System.Net.Http/HttpVersionPolicy.xml	✅Succeeded	View

For more details, please refer to the build report.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

For any questions, please:

Try searching in the Docs contributor and Admin Guide
See the frequently asked questions
Post your question in the Docs support channel

* Sync docs with source comments * Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> * Add values Co-authored-by: Jan Jahoda <jajahoda@.microsoft.com> Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com>

@wfurt

* Automatic port of System.OperatingSystem docs for RC2 (#4852) Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com> * Add Missing System.Diagnostics docs (#4856) * Add Missing System.Diagnostics docs * Apply suggestions from code review Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> * Automatically port System.Diagnostics docs for RC2 (#4853) * Automatically port System.Diagnostics docs for RC2 * Update xml/System.Diagnostics/ActivitySamplingResult.xml Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> * Update xml/System.Diagnostics/Process.xml Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com> Co-authored-by: Tarek Mahmoud Sayed <tarekms@microsoft.com> * Automatic port of RegexParse* documentation (#4850) * Automatic port of RegexParse* documentation * Update xml/System.Text.RegularExpressions/RegexParseError.xml * Apply suggestions from code review * Update RegexParseException * Update xml/System.Text.RegularExpressions/RegexParseException.xml * Update xml/System.Text.RegularExpressions/RegexParseException.xml Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com> Co-authored-by: Prashanth Govindarajan <prgovi@microsoft.com> * Add ssl API added between preview 7 and 8 (#4860) * Automatic port of Reflection RC2 documentation (#4851) * Revert "Add ssl API added between preview 7 and 8 (#4860)" (#4868) This reverts commit 10d2b88. * Add ssl API added between preview 7 and 8 #2 (#4869) * Add ssl API added between preview 7 and 8 * Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> * Update xml/System.Net.Security/SslStream.xml * Apply @wfurt comments * Add missing remark headers * Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Co-authored-by: Jan Jahoda <jajahoda@.microsoft.com> Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> * Documentation for System.Net.Http.SocketsHttpHandler.ConnectCallback (#4861) * Documentation for System.Net.Http.SocketsHttpHandler.ConnectCallback * Apply PR comments * Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Co-authored-by: Jan Jahoda <jajahoda@.microsoft.com> Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> * Add a remark to AddEvent method (#4871) * Add a remark to AddEvent method * Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> * Automatic port of CryptoStream docs (#4888) Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com> * Automatic port of System.Buffers docs (#4882) Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com> * resolve isprefix conflict * Automatic port of System.Data.Common docs (#4885) Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com> * Automatic port of *PipeServerStreamAcl docs (#4880) * Automatic port of *PipeServerStreamAcl docs * Apply suggestions from code review Co-authored-by: Prashanth Govindarajan <prgovi@microsoft.com> Co-authored-by: David Cantú <dacantu@microsoft.com> * Apply suggestions from code review Co-authored-by: David Cantú <dacantu@microsoft.com> * Apply suggestions from code review * Update xml/System.IO.Pipes/AnonymousPipeServerStreamAcl.xml * Update xml/System.IO.Pipes/AnonymousPipeServerStreamAcl.xml Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com> Co-authored-by: Prashanth Govindarajan <prgovi@microsoft.com> Co-authored-by: David Cantú <dacantu@microsoft.com> * Automatic port of *OSPlatformAttribute docs (#4883) * Automatic port of *OSPlatformAttribute docs * Missing TargetPlatformAttribute constructor parameter description. * Apply suggestions from code review Co-authored-by: Buyaa <buyankhishig.namnan@microsoft.com> * Update xml/System.Runtime.Versioning/SupportedOSPlatformAttribute.xml Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com> Co-authored-by: Buyaa <buyankhishig.namnan@microsoft.com> * Document System.Enum (#4894) Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com> * Document Half.op_Explicit APIs (#4893) * Document Half.op_Explicit APIs * Equals Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com> * Automatic port of Rune.CompareTo EII (#4891) Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com> * Add missing docs for AsnContentException. (#4895) * Add missing documentation for S.S.Cryptography (#4892) * Add missing documentation for S.S.Cryptography * Apply feedback * Automatic port of System.Threading.ExecutionContext.Restore doc (#4887) * Automatic port of System.Threading.ExecutionContext.Restore doc * Update xml/System.Threading/ExecutionContext.xml Co-authored-by: Prashanth Govindarajan <prgovi@microsoft.com> * Apply suggestions from code review Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com> Co-authored-by: Prashanth Govindarajan <prgovi@microsoft.com> * Automatic port of explicit interface implementation of System.Net.Http.HttpRequestOptions (#4881) * Automatic port of explicit interface implementations for System.Net.Http.HttpRequestOptions * Apply suggestions from code review Co-authored-by: Jan Jahoda <aik.jahoda@post.cz> Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com> Co-authored-by: Jan Jahoda <aik.jahoda@post.cz> * Document Type.IsAssignableTo (#4898) Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com> * Document System.PlatformID.Other (#4897) Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com> * HTTP Version Selection (#4870) * Sync docs with source comments * Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> * Add values Co-authored-by: Jan Jahoda <jajahoda@.microsoft.com> Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> * HttpClient sync operations (#4776) * Draft for @ManickaP * Apply suggestions from code review Co-authored-by: Marie Píchová <11718369+ManickaP@users.noreply.github.com> * Format verification * Format verification * Fix links * Fix links * Fix xml tag * Fix links * Fix links * Fix links * Apply suggestions from code review Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> * Fix links * Add CreateContentReadStream * Fix links * Add System.Net.Http.DelegatingHandler.Send * Fix links * Apply suggestions from code review Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> * Remove "Synchronous" information from summary * Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> * Fix the exception description Co-authored-by: Jan Jahoda <jajahoda@.microsoft.com> Co-authored-by: Marie Píchová <11718369+ManickaP@users.noreply.github.com> Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> * adding docs for missing 5.0 apis for system.Runtime.CompilerServices.Unsafe (#4902) * adding docs for missing 5.0 apis * Apply suggestions from code review Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> * resolve conflict * Add Sysytem.Net.* missing API (#4904) * System.Net.Http.SocketsHttpHandler.EnableMultipleHttp2Connections * Add Sysytem.Net.\* missing API * Apply PR comments * Apply suggestions from code review * Apply suggestions from code review * Update xml/System.Net.Http/SocketsHttpHandler.xml Co-authored-by: Jan Jahoda <jajahoda@.microsoft.com> Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> * Http sync follow up (#4905) * Add the http sync follow up * Fix closing tag Co-authored-by: Jan Jahoda <jajahoda@.microsoft.com> Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com> Co-authored-by: Tarek Mahmoud Sayed <tarekms@microsoft.com> Co-authored-by: Prashanth Govindarajan <prgovi@microsoft.com> Co-authored-by: Jan Jahoda <jajahoda@microsoft.com> Co-authored-by: Jan Jahoda <jajahoda@.microsoft.com> Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Co-authored-by: David Cantú <dacantu@microsoft.com> Co-authored-by: Buyaa <buyankhishig.namnan@microsoft.com> Co-authored-by: Jeremy Barton <jbarton@microsoft.com> Co-authored-by: Jan Jahoda <aik.jahoda@post.cz> Co-authored-by: Marie Píchová <11718369+ManickaP@users.noreply.github.com> Co-authored-by: Anirudh Agnihotry <anirudhagnihotry098@gmail.com>

Sync docs with source comments

a79d365

aik-jahoda requested review from ManickaP and gewarren September 17, 2020 13:10

This comment has been minimized.

Sign in to view

gewarren reviewed Sep 17, 2020

View reviewed changes

ManickaP approved these changes Sep 18, 2020

View reviewed changes

gewarren closed this Sep 18, 2020

gewarren reopened this Sep 18, 2020

This comment has been minimized.

Sign in to view

Apply suggestions from code review

6c467aa

Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>

aik-jahoda requested a review from gewarren September 21, 2020 14:06

pgovind reviewed Sep 21, 2020

View reviewed changes

xml/System.Net.Http/HttpClient.xml Show resolved Hide resolved

pgovind reviewed Sep 21, 2020

View reviewed changes

xml/System.Net.Http/HttpRequestMessage.xml Show resolved Hide resolved

pgovind reviewed Sep 21, 2020

View reviewed changes

xml/System.Net.Http/HttpVersionPolicy.xml Outdated Show resolved Hide resolved

pgovind reviewed Sep 21, 2020

View reviewed changes

gewarren reviewed Sep 21, 2020

View reviewed changes

xml/System.Net.Http/HttpVersionPolicy.xml Outdated Show resolved Hide resolved

aik-jahoda and others added 2 commits September 22, 2020 21:53

Apply suggestions from code review

7236a37

Co-authored-by: Carlos Sanchez <1175054+carlossanlop@users.noreply.github.com> Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>

Add values

f9f5151

carlossanlop approved these changes Sep 22, 2020

View reviewed changes

carlossanlop merged commit 7bdeb62 into dotnet:net5-rc2 Sep 22, 2020

carlossanlop deleted the jajahoda/httpversionselection branch September 22, 2020 20:51

carlossanlop added the area-System.Net.Http label Mar 5, 2021

	<summary>Uses only the requested version. Throwing <see cref="HttpRequestException" /> if a connection with the exact version cannot be established.</summary>
	<summary>Only use the requested version.</summary>

HTTP Version Selection #4870

HTTP Version Selection #4870

Uh oh!

Conversation

aik-jahoda commented Sep 17, 2020

Summary

Uh oh!

This comment has been minimized.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gewarren Sep 17, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ManickaP Sep 18, 2020

Choose a reason for hiding this comment

Uh oh!

aik-jahoda Sep 21, 2020

Choose a reason for hiding this comment

Uh oh!

gewarren Sep 21, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ManickaP left a comment

Choose a reason for hiding this comment

Uh oh!

gewarren commented Sep 18, 2020

Uh oh!

This comment has been minimized.

opbld34 commented Sep 21, 2020

⚠️ Validation status: warnings

xml/System.Net.Http/HttpVersionPolicy.xml

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pgovind Sep 21, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

opbld30 commented Sep 22, 2020

✅ Validation status: passed

Uh oh!

opbld31 commented Sep 22, 2020

✅ Validation status: passed

Uh oh!

Uh oh!

gewarren Sep 17, 2020 •

edited

Loading