x/stackalytics
Code Issues Proposed changes

Update API docs with time period params

Browse Source 
Change-Id: I1fd2c9c735aa6850824568900fba965e95276869
This commit is contained in:
Ilya Shakhat 2015-01-12 17:09:09 +03:00
parent 9daae43d2c
commit 3db5ce468a
1 changed files with 12 additions and 3 deletions

15
doc/source/userdoc/api_v1.0.rst

@ -52,17 +52,26 @@ All requests support common set of parameters that allow to filter resulting dat
+================+===========================================================================+
| release | Name of OpenStack release or 'all', by default current release |
+----------------+---------------------------------------------------------------------------+
| project_type | Type of project, e.g. 'core', by default 'openstack' |
| project_type | Type of project, by default 'openstack' |
+----------------+---------------------------------------------------------------------------+
| module | Name of module (repository name) |
+----------------+---------------------------------------------------------------------------+
| company | Company name |
+----------------+---------------------------------------------------------------------------+
| user_id | Launchpad id of user or email if no Laucnhpad id is mapped. |
| user_id | Launchpad id of user or email if no Launchpad id is mapped. |
+----------------+---------------------------------------------------------------------------+
| metric | Metric: 'commits', 'loc', 'marks', 'emails' |
| metric | Metric: e.g. 'commits', 'loc', 'marks', 'emails' |
+----------------+---------------------------------------------------------------------------+
2.1.1 Other query parameters
............................
Data can be queried by time period:
* ``start_date`` - when the period starts
* ``end_date`` - when the period ends
Note that if both release and time period are specified then the data is selected for the
intersection (thus the useful way is to specify release as ``all``).
2.2 Contribution by Modules
---------------------------