<div dir="ltr">The Nova proposal appears to be identical to neutron's, at least from a consumer perspective.<div><br></div><div>If I were to pick a winner, I'd follow Sean's advice regarding the 'more' attribute in responses, and put the total number of resources there; I would also take Jay's advice of including the total only if requested with a query param. In this way a user can retrieve the total number of items regardless of the current pagination index (in my first post I suggested the total number should be returned only on the first page of results).</div><div><br></div><div>Therefore one could ask for a total number of resources with something like the following:</div><div><br></div><div>GET /some_resources?include_total=1</div><div><br></div><div>and obtain a response like the following:</div><div><br></div><div><span class="im" style="font-family:arial,sans-serif;font-size:13px">{'resources': [{meh}, {meh}, {meh_again}],</span></div><div><span class="im" style="font-family:arial,sans-serif;font-size:13px">  'something': {</span></div><div><span class="im" style="font-family:arial,sans-serif;font-size:13px">       '_links': {'prev': ..., 'next': ...},</span></div><div><span class="im" style="font-family:arial,sans-serif;font-size:13px">       'total': agazillion}</span></div><div><span class="im" style="font-family:arial,sans-serif;font-size:13px"> }<br></span><br></div><div><font face="arial, sans-serif"> where the exact structure and naming of 'something' depends on the outcome of the discussion at [1]</font></div><div><font face="arial, sans-serif"><br></font></div><div><font face="arial, sans-serif">Salvatore</font></div><div><font face="arial, sans-serif"><br></font></div><div><font face="arial, sans-serif">[1] <a href="https://review.openstack.org/#/c/133660/7/guidelines/representation_structure.rst">https://review.openstack.org/#/c/133660/7/guidelines/representation_structure.rst</a></font></div></div><div class="gmail_extra"><br><div class="gmail_quote">On 20 November 2014 15:24, Christopher Yeoh <span dir="ltr"><<a href="mailto:cbkyeoh@gmail.com" target="_blank">cbkyeoh@gmail.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div class="HOEnZb"><div class="h5">On Thu, 20 Nov 2014 14:47:16 +0100<br>
Salvatore Orlando <<a href="mailto:sorlando@nicira.com">sorlando@nicira.com</a>> wrote:<br>
<br>
> Aloha guardians of the API!<br>
><br>
> I haven recently* reviewed a spec for neutron [1] proposing a<br>
> distinct URI for returning resource count on list operations.<br>
> This proposal is for selected neutron resources, but I believe the<br>
> topic is general enough to require a guideline for the API working<br>
> group. Your advice is therefore extremely valuable.<br>
><br>
> In a nutshell the proposal is to retrieve resource count in the<br>
> following way:<br>
> GET /<prefix>/<resource_name>/count<br>
><br>
> In my limited experience with RESTful APIs, I've never encountered<br>
> one that does counting in this way. This obviously does not mean it's<br>
> a bad idea. I think it's not great from a usability perspective to<br>
> require two distinct URIs to fetch the first page and then the total<br>
> number of elements. I reckon the first response page for a list<br>
> operation might include also the total count. For example:<br>
><br>
> {'resources': [{meh}, {meh}, {meh_again}],<br>
>  'resource_count': 55<br>
>  <link_to_next_page>}<br>
><br>
> I am however completely open to consider other alternatives.<br>
> What is your opinion on this matter?<br>
<br>
</div></div>FWIW there is a nova spec proposed for counting resources as<br>
well (I think it might have been previously approved for Juno).<br>
<br>
<a href="https://review.openstack.org/#/c/134279/" target="_blank">https://review.openstack.org/#/c/134279/</a><br>
<br>
I haven't compared the two, but I can't think of a reason we'd<br>
need to be any different between projects here.<br>
<br>
Regards,<br>
<br>
Chris<br>
<span class="im HOEnZb"><br>
><br>
> Regards,<br>
> Salvatore<br>
><br>
><br>
> * it's been 10 days now<br>
><br>
> [1] <a href="https://review.openstack.org/#/c/102199/" target="_blank">https://review.openstack.org/#/c/102199/</a><br>
<br>
<br>
</span><div class="HOEnZb"><div class="h5">_______________________________________________<br>
OpenStack-dev mailing list<br>
<a href="mailto:OpenStack-dev@lists.openstack.org">OpenStack-dev@lists.openstack.org</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev</a><br>
</div></div></blockquote></div><br></div>