
<html><body>

<p><font size="2" face="sans-serif">I have proposed an addition to the REST API doc for cinder to add</font><br>

<font size="2" face="sans-serif">sorting to the GET volumes queries [1]. While doing this work, I</font><br>

<font size="2" face="sans-serif">noticed that the pagination parameters (eg, limit/marker) were</font><br>

<font size="2" face="sans-serif">missing from the cinder documentation. I have looked at how the</font><br>

<font size="2" face="sans-serif">other projects have documented this and I see that they are not</font><br>

<font size="2" face="sans-serif">consistent.</font><br>

<br>

<font size="2" face="sans-serif">For example:</font><br>

<br>

<font size="2" face="sans-serif">Compute v2:</font><br>

<font size="2" face="sans-serif">* limit: Integer value for the limit of values to return. </font><br>

<font size="2" face="sans-serif">* marker: UUID of the <server/flavor/image> at which you want to set a</font><br>

<font size="2" face="sans-serif">marker. </font><br>

<br>

<font size="2" face="sans-serif">Identity v2:</font><br>

<font size="2" face="sans-serif">* limit: The page size.</font><br>

<font size="2" face="sans-serif">* marker: The ID of the last item in the previous list.</font><br>

<br>

<font size="2" face="sans-serif">Image v2:</font><br>

<font size="2" face="sans-serif">* limit: Use to request a specific page size. Expect a response to a</font><br>

<font size="2" face="sans-serif">limited request to return between zero and limit items. The typical</font><br>

<font size="2" face="sans-serif">pattern of limit and marker is to make an initial limited request and</font><br>

<font size="2" face="sans-serif">then to use the ID of the last image from the response as the marker</font><br>

<font size="2" face="sans-serif">parameter in a subsequent limited request.</font><br>

<font size="2" face="sans-serif">* marker: Specifies the ID of the last-seen image. The typical pattern</font><br>

<font size="2" face="sans-serif">of limit and marker is to make an initial limited request and then to</font><br>

<font size="2" face="sans-serif">use the ID of the last image from the response as the marker parameter</font><br>

<font size="2" face="sans-serif">in a subsequent limited request. </font><br>

<br>

<font size="2" face="sans-serif">Object Storage v1:</font><br>

<font size="2" face="sans-serif">* limit: For an integer value n, limits the number of results to n. </font><br>

<font size="2" face="sans-serif">* marker: For a string value x, returns container names that are</font><br>

<font size="2" face="sans-serif">greater in value than the specified marker.</font><br>

<br>

<font size="2" face="sans-serif">Orchestration v1:</font><br>

<font size="2" face="sans-serif">* limit: Limits the number of stacks that appear on a page to this</font><br>

<font size="2" face="sans-serif">value. The typical pattern of limit and marker is to make an initial</font><br>

<font size="2" face="sans-serif">limited request and then to use the ID of the last stack from the</font><br>

<font size="2" face="sans-serif">response as the marker parameter in a subsequent limited request. </font><br>

<font size="2" face="sans-serif">* marker: Specifies the ID of the last-seen stack. The typical</font><br>

<font size="2" face="sans-serif">pattern of limit and marker is to make an initial limited request</font><br>

<font size="2" face="sans-serif">and then to use the ID of the last stack from the response as the</font><br>

<font size="2" face="sans-serif">marker parameter in a subsequent limited request. </font><br>

<br>

<font size="2" face="sans-serif">Telemetry v1:</font><br>

<font size="2" face="sans-serif">* limit: Maximum number of samples to return.</font><br>

<br>

<font size="2" face="sans-serif">IMO, instead of adding yet another definition for the limit/marker</font><br>

<font size="2" face="sans-serif">parameters for cinder, the definition of these parameters could be</font><br>

<font size="2" face="sans-serif">made generic and shared across all projects.</font><br>

<br>

<font size="2" face="sans-serif">I see that there is no cross-project equivalent common.ent file. Any</font><br>

<font size="2" face="sans-serif">thoughts or objections to creating one and then updating the above</font><br>

<font size="2" face="sans-serif">projects to use it for limit and marker? Obviously the parameter</font><br>

<font size="2" face="sans-serif">definitions needs to be made generic and we can use a gerrit review</font><br>

<font size="2" face="sans-serif">to hash out those details.</font><br>

<br>

<font size="2" face="sans-serif">Thanks for the feedback!</font><br>

<br>

<font size="2" face="sans-serif">[1] </font><a href="https://review.openstack.org/#/c/160550/"><font size="2" face="sans-serif">https://review.openstack.org/#/c/160550/</font></a><br>

<br>

<font size="2" face="sans-serif">Steven Kaufer</font></body></html>