Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(GH-10801) Fix -OutFile for web request cmdlets #10804

Merged

Conversation

michaeltlombardi
Copy link
Contributor

@michaeltlombardi michaeltlombardi commented Jan 17, 2024

PR Summary

Prior to this change, the documentation for the -OutFile parameter of the Invoke-WebRequest cmdlet incorrectly mentioned retrieving the filename from the Content-Disposition. This functionality isn't implemented. Further, the -OutFile parameter for Invoke-RestMethod is missing any version-specific note, even though the behavior is the same.

This change:

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.

Prior to this change, the documentation for the `-OutFile` parameter
of the `Invoke-WebRequest` cmdlet incorrectly mentioned retrieving
the filename from the Content-Disposition. This functionality isn't
implemented. Further, the `-OutFile` parameter for `Invoke-RestMethod`
is missing any version-specific note, even though the behavior is the
same.

This change:

- Fixes the wording for the `-OutFile` parameter in `Invoke-WebRequest`
  to remove the non-implemented detail.
- Adds a note to the documentation for `Invoke-RestMethod` about the
  automatic naming.
- Resolves MicrosoftDocs#10801
- Fixes AB#200725
Copy link
Contributor

Learn Build status updates of commit ce4a2ce:

✅ Validation status: passed

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

For more details, please refer to the build report.

For any questions, please:

@sdwheeler sdwheeler merged commit 7da23e5 into MicrosoftDocs:main Jan 17, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

-OutFile parameter description is incorrect with respect to v7.4+ behavior
2 participants