[aerogear-dev] Web Linking and Paging

[Matthias Wessendorf]

On Sat, Jan 19, 2013 at 12:07 PM, Matthias Wessendorf <matzew at apache.org> wrote:
> On Fri, Jan 18, 2013 at 11:24 PM, Kris Borchers <kris at redhat.com> wrote:
>> Since we decided to use the Web Linking standard (RFC 5988) for controller's paging implementation, it was also decided to remove the "offset" and "limit" from the response headers since that info is in the links. Though I think it could be useful to still include those headers, I think it can be ok without them.
>>
>
> No strong opinion on including/excluding "AG-Paging-Offset" and
> "AG-Paging-Limit"...
>
>> That being said, it got me to thinking about those links. The question that occurred to me was whether or not those links included all other query params that were used to generate this paged result.
>> I would really hope that it did, otherwise these links would be pretty much useless since they would link to a paged result of unfiltered items. I just want to verify the following items and make sure we're
>> all on the same page:
>
> The spec does not say (or I have hard time finding that info :-))
>
> BUT.... I'd assume that ALL query params MUST be included in those
> links (since they 'drove' the current response).
>
> BTW: https://twitter.com/mwessendorf/status/292588441772900352


The GH pagination API does that:

from the response:
Link: <https://api.github.com/users/matzew/gists?mimi=yes&page=3&per_page=1>;
rel="next", <https://api.github.com/users/matzew/gists?mimi=yes&page=70&per_page=1>;
rel="last", <https://api.github.com/users/matzew/gists?mimi=yes&page=1&per_page=1>;
rel="first", <https://api.github.com/users/matzew/gists?mimi=yes&page=1&per_page=1>;
rel="prev"


based on this request:
curl -i "https://api.github.com/users/matzew/gists?page=2&per_page=1&mimi=yes"


>
>>
>> 1) Controller should include any and all filtering parameters that were used to generate the paged result set in the web linking headers.
>
> +1
>
>> 2) If other servers for some reason do not include that information, that is not a problem our clients have to deal with. We should be free to assume that if the server is use web linking as its paging
>> implementation, it is providing the necessary information in that link to get to the next or previous page in that filtered set.
>
> Yo! +1
>
> -M
>
>> _______________________________________________
>> aerogear-dev mailing list
>> aerogear-dev at lists.jboss.org
>> https://lists.jboss.org/mailman/listinfo/aerogear-dev
>
>
>
> --
> Matthias Wessendorf
>
> blog: http://matthiaswessendorf.wordpress.com/
> sessions: http://www.slideshare.net/mwessendorf
> twitter: http://twitter.com/mwessendorf



-- 
Matthias Wessendorf

blog: http://matthiaswessendorf.wordpress.com/
sessions: http://www.slideshare.net/mwessendorf
twitter: http://twitter.com/mwessendorf