[openstack-dev] [nova][api] Pagination in thre API

Everett Toews everett.toews at RACKSPACE.COM
Thu Nov 5 15:16:12 UTC 2015


On Nov 5, 2015, at 5:44 AM, John Garbutt <john at johngarbutt.com<mailto:john at johngarbutt.com>> wrote:

On 5 November 2015 at 09:46, Richard Jones <r1chardj0n3s at gmail.com<mailto:r1chardj0n3s at gmail.com>> wrote:
As a consumer of such APIs on the Horizon side, I'm all for consistency in
pagination, and more of it, so yes please!

On 5 November 2015 at 13:24, Tony Breeds <tony at bakeyournoodle.com<mailto:tony at bakeyournoodle.com>> wrote:

On Thu, Nov 05, 2015 at 01:09:36PM +1100, Tony Breeds wrote:
Hi All,
   Around the middle of October a spec [1] was uploaded to add
pagination
support to the os-hypervisors API.  While I recognize the use case it
seemed
like adding another pagination implementation wasn't an awesome idea.

Today I see 3 more requests to add pagination to APIs [2]

Perhaps I'm over thinking it but should we do something more strategic
rather
than scattering "add pagination here".

+1

The plan, as I understand it, is to first finish off this API WG guideline:
http://specs.openstack.org/openstack/api-wg/guidelines/pagination_filter_sort.html


An attempt at an API guideline for pagination is here [1] but hasn't received any updates in over a month, which can be understandable as sometimes other work takes precedence.

Perhaps we can get that guideline moving again?

If it's becoming difficult to reach agreement on that approach in the guideline, it could be worthwhile to take a step back and do some analysis on the way pagination is done in the more established APIs. I've found that such analysis can be very helpful as you're moving forward from a known state.

The place for that analysis is in Current Design [2] by filling in the Pagination page. You can find many examples of such analysis from the Current Design like Sorting [3].

Cheers,
Everett


[1] https://review.openstack.org/#/c/190743/
[2] https://wiki.openstack.org/wiki/API_Working_Group/Current_Design
[3] https://wiki.openstack.org/wiki/API_Working_Group/Current_Design/Sorting

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20151105/ce6204cf/attachment.html>


More information about the OpenStack-dev mailing list