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-11155) Document body-to-query-param encoding #11157

Conversation

michaeltlombardi
Copy link
Contributor

@michaeltlombardi michaeltlombardi commented Jun 3, 2024

PR Summary

Prior to this change, the documentation didn't clearly indicate that the converted key-value pairs for requests from the Body parameter were URL encoded or point users to how those strings are encoded.

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 didn't clearly indicate that the
converted key-value pairs for requests from the **Body** parameter were
URL encoded or point users to how those strings are encoded.

This change:

- Adds a brief note indicating that the cmdlet uses the `WebUtility.UrlEncode()`
  method and points to that method reference for more information about the
  encoding behavior.
- Resolves MicrosoftDocs#11155
- Fixes AB#260889
Copy link
Contributor

Learn Build status updates of commit 59f5456:

⚠️ Validation status: warnings

File Status Preview URL Details
reference/7.2/Microsoft.PowerShell.Utility/Invoke-RestMethod.md ⚠️Warning View (powershell-7.2) Details
reference/7.2/Microsoft.PowerShell.Utility/Invoke-WebRequest.md ⚠️Warning View (powershell-7.2) Details
reference/7.4/Microsoft.PowerShell.Utility/Invoke-RestMethod.md ⚠️Warning View (powershell-7.4) Details
reference/7.4/Microsoft.PowerShell.Utility/Invoke-WebRequest.md ⚠️Warning View (powershell-7.4) Details
reference/7.5/Microsoft.PowerShell.Utility/Invoke-RestMethod.md ⚠️Warning View (powershell-7.5) Details
reference/7.5/Microsoft.PowerShell.Utility/Invoke-WebRequest.md ⚠️Warning View (powershell-7.5) Details

reference/7.2/Microsoft.PowerShell.Utility/Invoke-RestMethod.md

  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'System.Net.WebUtility.UrlEncode'.

reference/7.2/Microsoft.PowerShell.Utility/Invoke-WebRequest.md

  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'System.Net.WebUtility.UrlEncode'.

reference/7.4/Microsoft.PowerShell.Utility/Invoke-RestMethod.md

  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'System.Net.WebUtility.UrlEncode'.

reference/7.4/Microsoft.PowerShell.Utility/Invoke-WebRequest.md

  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'System.Net.WebUtility.UrlEncode'.

reference/7.5/Microsoft.PowerShell.Utility/Invoke-RestMethod.md

  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'System.Net.WebUtility.UrlEncode'.

reference/7.5/Microsoft.PowerShell.Utility/Invoke-WebRequest.md

  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'System.Net.WebUtility.UrlEncode'.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions 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:

@sdwheeler sdwheeler merged commit 3cec573 into MicrosoftDocs:main Jun 3, 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.

Explain URL encoding when passing query parameters to body
2 participants