diff --git a/doc/source/userdoc/api_v1.0.rst b/doc/source/userdoc/api_v1.0.rst index 8e5448b8a..1ba709e2c 100644 --- a/doc/source/userdoc/api_v1.0.rst +++ b/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 ---------------------------