(GH-9093) Clarify web cmdlet header validation by michaeltlombardi · Pull Request #9100 · MicrosoftDocs/PowerShell-Docs

michaeltlombardi · 2022-08-08T17:30:43Z

PR Summary

Prior to this change, the Invoke-WebRequest and Invoke-RestMethod
cmdlets in 7.0.0 and higher included the SkipHeaderValidation
parameter but not a specific example showing its use.

This change adds a new example for both cmdlets to show:

How the cmdlets behave when an invalidly formatted value is specified
for a header that has validation
How the cmdlets behave when the value is valid
How the SkipHeaderValidation parameter allows users to use values
that would normally fail validation.

This change also updates the formatting for the updated files to ease
future maintenance.

PR Checklist

Descriptive Title: This PR's title is a synopsis of the changes it proposes.
Summary: This PR's summary describes the scope and intent of the change.
Contributor's Guide: I have read the contributors guide.
Style: This PR adheres to the style guide.

opbld32 · 2022-08-08T18:31:41Z

Docs Build status updates of commit 171817d:

✅ Validation status: passed

File	Status	Preview URL	Details
reference/7.0/Microsoft.PowerShell.Utility/Invoke-RestMethod.md	✅Succeeded	View (powershell-7)
reference/7.0/Microsoft.PowerShell.Utility/Invoke-WebRequest.md	✅Succeeded	View (powershell-7)

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 the docs.microsoft.com contributor guides
Post your question in the Docs support channel

Prior to this change, the `Invoke-WebRequest` and `Invoke-RestMethod` cmdlets in 7.0.0 and higher included the **SkipHeaderValidation** parameter but not a specific example showing its use. This change adds a new example for both cmdlets to show: - How the cmdlets behave when an invalidly formatted value is specified for a header that has validation - How the cmdlets behave when the value is valid - How the **SkipHeaderValidation** parameter allows users to use values that would normally fail validation. This change also updates the formatting for the updated files to ease future maintenance.

opbld31 · 2022-08-08T19:37:11Z

Docs Build status updates of commit e69b544:

✅ Validation status: passed

File	Status	Preview URL
reference/7.0/Microsoft.PowerShell.Utility/Invoke-RestMethod.md	✅Succeeded	View (powershell-7)
reference/7.0/Microsoft.PowerShell.Utility/Invoke-WebRequest.md	✅Succeeded	View (powershell-7)
reference/7.2/Microsoft.PowerShell.Utility/Invoke-RestMethod.md	✅Succeeded	View (powershell-7.2)
reference/7.2/Microsoft.PowerShell.Utility/Invoke-WebRequest.md	✅Succeeded	View (powershell-7.2)
reference/7.3/Microsoft.PowerShell.Utility/Invoke-RestMethod.md	✅Succeeded	View (powershell-7.3)
reference/7.3/Microsoft.PowerShell.Utility/Invoke-WebRequest.md	✅Succeeded	View (powershell-7.3)

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 the docs.microsoft.com contributor guides
Post your question in the Docs support channel