x/stackalytics
Code Issues Proposed changes

Add activity log paging parameters to docs

Browse Source 
This modification to the API documentation adds a reference to the page_size
and start_record parameters, which are used to manage paging of results.

Change-Id: I0ba0decf4f6b2c805a4cc8292fce3678e5ae30ed
This commit is contained in:
Jamie Finnigan 2015-06-22 22:27:05 -07:00
parent 819d34be77
commit a2e643815d
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/source/userdoc/api_v1.0.rst
View File

@ -289,6 +289,10 @@ Depending on selected metric Activity log contains commits, reviews, emails or b
| GET | /api/1.0/activity | Activity log | | GET | /api/1.0/activity | Activity log |
+-----------------+-------------------------------------------------------------------+-----------------------------------------------------+ +-----------------+-------------------------------------------------------------------+-----------------------------------------------------+
When querying the activity log, the page_size and start_record parameters can be used to manage
the paging of results (splitting results over multiple requests/responses). The default value of
page_size is 10.
**Example Response** **Example Response**
.. sourcecode:: json .. sourcecode:: json