Support Link Header pagination in WebCmdlets by SteveL-MSFT · Pull Request #3828 · PowerShell/PowerShell · GitHub

Implements https://github.com/PowerShell/PowerShell-RFC/blob/master/2-Draft-Accepted/RFC0021-Link-header-based-pagination-for-WebCmdlets.md

When the response includes a Link Header (https://tools.ietf.org/html/rfc5988#page-6), for Invoke-WebRequest we create a RelationLink property that is a Dictionary representing the URLs and rel attributes and ensure the URLs are absolute to make it easier for the developer to use. For Invoke-RestMethod, we expose a -FollowRelLink switch to automatically follow 'next' rel links to the end until we hit the optional -MaximumFollowRelLink parameter value.

Since we will eventually remove the FullClr code, I didn't make the effort to add the same changes to the CoreClr sources to the FullClr sources.

Fix #3041

Doc update MicrosoftDocs/PowerShell-Docs#1232

…e end user implementing: https://github.com/PowerShell/PowerShell-RFC/blob/master/2-Draft-Accepted/RFC0021-Link-header-based-pagination-for-WebCmdlets.md When the response includes a Link Header (https://tools.ietf.org/html/rfc5988#page-6), for Invoke-WebRequest we create a RelationLink property that is a Dictionary representing the URLs and rel attributes and ensure the URLs are absolute to make it easier for the developer to use. For Invoke-RestMethod, we expose a -FollowRelLink switch to automatically follow 'next' rel links to the end until we hit the optional -MaxRelLink parameter value.

Isn't -FL -ML 0 contradictory? If you agree, I would use 1 for the minimum.

Yes, 1 makes sense

This string should be in a resx for localization.

And I see you just followed the pattern in the rest of this method - you should fix all of them at the same time.

Since there's only 3 I see in this file, I'll fix them with this PR

Does it make sense to have a public setter?

Also note how the Headers property is get only and returns a copy of the internal Headers. This isn't ideal because people write code like:

if (obj.Headers.ContainsKey("Something"))
{
    obj.Headers["Something"] ...
}

And this usage would create 2 copies of the dictionary. It's better to use ReadOnlyDictionary.

Created #3842 for the Headers issue

Will make the setter internal

You should not create a new Regex like this, instead you should prefer the static method, see the best practices.

Will fix

I think it we be better to use a local variable instead of modifying the cmdlet parameter.

Will fix

Should you skip parsing the header when we're not following pages?

Will fix

Docs update PR?

Travis Plunk (@TravisEz13) added link to doc PR

* Support Link Header pagination in WebCmdlets to make it easier for the end user implementing: https://github.com/PowerShell/PowerShell-RFC/blob/master/2-Draft-Accepted/RFC0021-Link-header-based-pagination-for-WebCmdlets.md When the response includes a Link Header (https://tools.ietf.org/html/rfc5988#page-6), for Invoke-WebRequest we create a RelationLink property that is a Dictionary representing the URLs and rel attributes and ensure the URLs are absolute to make it easier for the developer to use. For Invoke-RestMethod, we expose a -FollowRelLink switch to automatically follow 'next' rel links to the end until we hit the optional -MaxRelLink parameter value. * removed unnecessary refs to namespaces * addressed code review feedback

Steve Lee (SteveL-MSFT) assigned Travis Plunk (TravisEz13) May 19, 2017

Steve Lee (SteveL-MSFT) requested review from Francisco Gamino (Francisco-Gamino) and Dan Travison (dantraMSFT) May 19, 2017 20:32

Microsoft Contribution License Agreements (msftclas) added the cla-not-required label May 19, 2017

removed unnecessary refs to namespaces

283f31a

Jason Shirk (lzybkr) reviewed May 22, 2017

View reviewed changes

addressed code review feedback

cbf2afb

Jason Shirk (lzybkr) approved these changes May 23, 2017

View reviewed changes

Travis Plunk (TravisEz13) added the Area-Cmdlets-Utility label May 24, 2017

Travis Plunk (TravisEz13) merged commit 40446c8 into PowerShell:master May 24, 2017

Steve Lee (SteveL-MSFT) deleted the webcmdlets-link-header branch May 24, 2017 23:04

Ryan Yates (kilasuit) added WG-Cmdlets general cmdlet issues and removed WG-Cmdlets-Utility labels Jul 17, 2026

+                      /// </summary>
+                      [Parameter]
+                      [Alias("ML")]
+                      [ValidateRange(0, Int32.MaxValue)]

+                      /// <summary>
+                      /// gets the RelationLink property
+                      /// </summary>
+                      public Dictionary<string, string> RelationLink { get; set; }

+                                      if (followedRelLink > 0)
+                                      {
+                                          string linkVerboseMsg = string.Format(CultureInfo.CurrentCulture,
+                                              "Following rel link {0}",

+                          // we only support the URL in angle brackets and `rel`, other attributes are ignored
+                          // user can still parse it themselves via the Headers property
+                          Regex regex = new Regex("<(?<url>.*?)>;\\srel=\"(?<rel>.*?)\"");

+                                              {
+                                                  return;
+                                              }
+                                              Uri = new Uri(_relationLink["next"]);

+                                                  ThrowTerminatingError(er);
+                                              }
+                                              ParseLinkHeader(response, Uri);

Support Link Header pagination in WebCmdlets by SteveL-MSFT · Pull Request #3828 · PowerShell/PowerShell · GitHub

Uh oh!

Support Link Header pagination in WebCmdlets - #3828

Support Link Header pagination in WebCmdlets#3828Travis Plunk (TravisEz13) merged 3 commits intoPowerShell:masterPowerShell/PowerShell:masterfrom SteveL-MSFT:webcmdlets-link-headerSteveL-MSFT/PowerShell:webcmdlets-link-headerCopy head branch name to clipboard

Conversation

Steve Lee (SteveL-MSFT) commented May 19, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Travis Plunk (TravisEz13) commented May 24, 2017

Uh oh!

Steve Lee (SteveL-MSFT) commented May 24, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Support Link Header pagination in WebCmdlets#3828
Travis Plunk (TravisEz13) merged 3 commits into
PowerShell:masterfrom
SteveL-MSFT:webcmdlets-link-header

Steve Lee (SteveL-MSFT) commented May 19, 2017 •
edited
Loading