[OpenStack-docs] Standardizing pagination REST API query string parameters

Steven Kaufer kaufer at us.ibm.com
Wed Mar 4 05:59:19 UTC 2015


Anne Gentle <annegentle at justwriteclick.com> wrote on 03/03/2015 01:42:50
PM:

> From: Anne Gentle <annegentle at justwriteclick.com>
> To: Steven Kaufer/Rochester/IBM at IBMUS
> Cc: "openstack-docs at lists.openstack.org"
<openstack-docs at lists.openstack.org>
> Date: 03/03/2015 01:43 PM
> Subject: Re: [OpenStack-docs] Standardizing pagination REST API
> query string parameters
>
>
> On Mar 3, 2015, at 12:48 PM, Steven Kaufer <kaufer at us.ibm.com> wrote:

> I have proposed an addition to the REST API doc for cinder to add
> sorting to the GET volumes queries [1]. While doing this work, I
> noticed that the pagination parameters (eg, limit/marker) were
> missing from the cinder documentation. I have looked at how the
> other projects have documented this and I see that they are not
> consistent.
>
...
>
> IMO, instead of adding yet another definition for the limit/marker
> parameters for cinder, the definition of these parameters could be
> made generic and shared across all projects.
>
> I see that there is no cross-project equivalent common.ent file. Any
> thoughts or objections to creating one and then updating the above
> projects to use it for limit and marker? Obviously the parameter
> definitions needs to be made generic and we can use a gerrit review
> to hash out those details.

>
> Sure, works for me! And like you say, we can figure out how to write
> it generically in the review itself.
>
> Thanks for bringing it here for input.
> Anne

Thanks for the feedback Anne, the review is here:
https://review.openstack.org/#/c/161102

Thanks,
Steven Kaufer

> Thanks for the feedback!
>
> [1] https://review.openstack.org/#/c/160550/
>
> Steven Kaufer
> _______________________________________________
> OpenStack-docs mailing list
> OpenStack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20150303/e3f0660b/attachment-0001.html>


More information about the OpenStack-docs mailing list