Add option 'S' to projects REST API to support query offset
List projects endpoint has an option to limit the number of results
returned but it was missing an option to start at a nonzero offset in
order to support results paging.
Add and document 'S' option which allow to query project list starting
at a nonzero offset. Also add missing documentation for the 'n' option
which limits the number of results.
Those 2 options will be then used to render project list with pagination
in web UI.
Change-Id: I19c4cd1cfa6ed78f22c84f249af54a5c30387561
diff --git a/Documentation/rest-api-projects.txt b/Documentation/rest-api-projects.txt
index 1409e96..418b93c 100644
--- a/Documentation/rest-api-projects.txt
+++ b/Documentation/rest-api-projects.txt
@@ -92,6 +92,22 @@
----
E.g. this feature can be used by suggestion client UI's to limit results.
+The `/projects/` URL also accepts a limit integer in the `n` parameter.
+This limits the results to show `n` projects.
+
+Query the first 25 projects in project list.
+----
+ GET /projects/?n=25 HTTP/1.0
+----
+
+The `/projects/` URL also accepts a start integer in the `S` parameter.
+The results will skip `S` projects from project list.
+
+Query 25 projects starting from index 50.
+----
+ GET /projects/?n=25&S=50 HTTP/1.0
+----
+
[[get-project]]
=== Get Project
--
