Fix WebHeaderCollection header restrictions docs #4972
Conversation
|
Docs Build status updates of commit 4f3d5d3:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| xml/Microsoft.Build.Graph/ProjectGraph.xml | View | Details | |
| xml/Microsoft.Extensions.DependencyInjection/PollyHttpClientBuilderExtensions.xml | View | Details | |
| xml/Microsoft.Extensions.DependencyInjection/PollyServiceCollectionExtensions.xml | View | Details | |
| xml/Microsoft.Extensions.Localization/ResourceManagerStringLocalizer.xml | View | Details | |
| xml/System.Net/WebHeaderCollection.xml | ✅Succeeded | View |
xml/Microsoft.Build.Graph/ProjectGraph.xml
- Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Microsoft.Build.BackEnd.CircularDependencyException'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Microsoft.Build.BackEnd.CircularDependencyException'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Microsoft.Build.BackEnd.CircularDependencyException'.
xml/Microsoft.Extensions.DependencyInjection/PollyHttpClientBuilderExtensions.xml
- Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Polly.IAsyncPolicy`1'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Polly.Registry.IReadOnlyPolicyRegistry`1'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Polly.IAsyncPolicy`1'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Polly.Registry.IReadOnlyPolicyRegistry`1'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Polly.Registry.IReadOnlyPolicyRegistry`1'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Polly.Registry.IReadOnlyPolicyRegistry`1'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Polly.IAsyncPolicy`1'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Polly.PolicyBuilder`1'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Polly.IAsyncPolicy`1'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Polly.Policy'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Polly.PolicyBuilder`1'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Polly.IAsyncPolicy`1'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Polly.IAsyncPolicy`1'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Polly.IAsyncPolicy`1'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Polly.IAsyncPolicy`1'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Polly.IAsyncPolicy`1'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Polly.IAsyncPolicy`1'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Polly.IAsyncPolicy`1'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Polly.IAsyncPolicy`1'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Polly.IAsyncPolicy`1'.
xml/Microsoft.Extensions.DependencyInjection/PollyServiceCollectionExtensions.xml
- Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Polly.Registry.IPolicyRegistry`1'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Polly.Registry.PolicyRegistry'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Polly.Registry.PolicyRegistry'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Polly.Registry.IPolicyRegistry`1'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Polly.Registry.IReadOnlyPolicyRegistry`1'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Polly.Registry.IPolicyRegistry`1'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Polly.Registry.IPolicyRegistry`1'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Polly.Registry.IPolicyRegistry`1'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Polly.Registry.IPolicyRegistry`1'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Polly.Registry.IPolicyRegistry`1'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Polly.Registry.IPolicyRegistry`1'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Polly.Registry.IReadOnlyPolicyRegistry`1'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Polly.Registry.IPolicyRegistry`1'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Polly.Registry.IReadOnlyPolicyRegistry`1'.
xml/Microsoft.Extensions.Localization/ResourceManagerStringLocalizer.xml
- Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Microsoft.Extensions.Localization.ResourceManagerStringLocalizer._resourceManager'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Microsoft.Extensions.Localization.Internal.AssemblyWrapper'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Microsoft.Extensions.Localization.Internal.IResourceStringProvider'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Microsoft.Extensions.Localization.Internal.AssemblyWrapper'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'Microsoft.Extensions.Localization.Internal.IResourceStringProvider'.
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
| ## Remarks | ||
| The <xref:System.Net.WebHeaderCollection> class is generally accessed through <xref:System.Net.WebRequest.Headers%2A?displayProperty=nameWithType> or <xref:System.Net.WebResponse.Headers%2A?displayProperty=nameWithType>. Some common headers are considered restricted and are either exposed directly by the API (such as `Content-Type`) or protected by the system and cannot be changed. | ||
| The <xref:System.Net.WebHeaderCollection> class is generally accessed through <xref:System.Net.WebRequest.Headers%2A?displayProperty=nameWithType> or <xref:System.Net.WebResponse.Headers%2A?displayProperty=nameWithType>. On .NET Framework, some common headers are considered restricted and are either exposed directly by the API (such as `Content-Type`) or protected by the system and cannot be changed. This does *not* apply to .NET Core versions through version 3.1, .NET 5.0 and later versions. |
There was a problem hiding this comment.
| The <xref:System.Net.WebHeaderCollection> class is generally accessed through <xref:System.Net.WebRequest.Headers%2A?displayProperty=nameWithType> or <xref:System.Net.WebResponse.Headers%2A?displayProperty=nameWithType>. On .NET Framework, some common headers are considered restricted and are either exposed directly by the API (such as `Content-Type`) or protected by the system and cannot be changed. This does *not* apply to .NET Core versions through version 3.1, .NET 5.0 and later versions. | |
| The <xref:System.Net.WebHeaderCollection> class is generally accessed through <xref:System.Net.WebRequest.Headers%2A?displayProperty=nameWithType> or <xref:System.Net.WebResponse.Headers%2A?displayProperty=nameWithType>. | |
| On .NET Framework, some common headers are considered restricted and are either exposed directly by the API (such as `Content-Type`) or protected by the system and cannot be changed. This does *not* apply to .NET Core and .NET 5.0 and later versions. |
|
Docs Build status updates of commit 4d4a643: ✅ Validation status: passed
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:
|
| The <xref:System.Net.WebHeaderCollection> class is generally accessed through <xref:System.Net.WebRequest.Headers%2A?displayProperty=nameWithType> or <xref:System.Net.WebResponse.Headers%2A?displayProperty=nameWithType>. | ||
| On .NET Framework, some common headers are considered restricted and are either exposed directly by the API (such as `Content-Type`) or protected by the system and cannot be changed. This does *not* apply to .NET Core versions through version 3.1, .NET 5.0 and later versions. |
There was a problem hiding this comment.
| On .NET Framework, some common headers are considered restricted and are either exposed directly by the API (such as `Content-Type`) or protected by the system and cannot be changed. This does *not* apply to .NET Core versions through version 3.1, .NET 5.0 and later versions. | |
| On .NET Framework, some common headers are considered restricted and are either exposed directly by the API (such as `Content-Type`) or protected by the system and cannot be changed. This does *not* apply to .NET Core - none of the headers are restricted there. |
There was a problem hiding this comment.
I'd leave out the .NET Core versions IMO -- it is missing from the time the APIs were ported to .NET Core -- whichever the version was.
There was a problem hiding this comment.
I followed the pattern from when I described max header length check behavior change here #4642 but I see now that current situation is a bit different (for max length check, it also changed since 5.0, that's why .NET Core version was explicitly specified) -- but I'd still leave ".NET Core, .NET 5.0 and later versions" to avoid confusion
|
Docs Build status updates of commit 54e6158: 🕙 Pending: waiting for processors (5 builds ahead of you) |
|
Docs Build status updates of commit 54e6158: ✅ Validation status: passed
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:
|
It's tricky because .NET 5 is technically .NET Core. We could change it to "This does not apply to .NET Core and .NET 5+". |
|
Docs Build status updates of commit 76b24f7: ✅ Validation status: passed
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:
|
Fix WebHeaderCollection header restrictions docs according to its implementation.
Header restrictions are not checked since WebHeaderCollection was transferred to .NET Core.