summaryrefslogtreecommitdiff
path: root/doc/api/projects.md
diff options
context:
space:
mode:
authorMark Fletcher <mark@gitlab.com>2017-05-01 17:42:42 +0800
committerMark Fletcher <mark@gitlab.com>2017-05-03 18:45:19 +0800
commit21f5515a5ffb46bb2e710c17690122903bca126e (patch)
tree64e75fdfd749195d2f6b3fb9fb42572ab88b6a4a /doc/api/projects.md
parent3aca8b6557a638e0634065a1c72d87861b9ace4a (diff)
downloadgitlab-ce-21f5515a5ffb46bb2e710c17690122903bca126e.tar.gz
Expose project statistics on single requests via the API
+ The statistics parameter was already accepted * This commit ensure that it is respected for GET /projects/:id endpoint + Add documentation of the parameter and update the example response for stats
Diffstat (limited to 'doc/api/projects.md')
-rw-r--r--doc/api/projects.md10
1 files changed, 9 insertions, 1 deletions
diff --git a/doc/api/projects.md b/doc/api/projects.md
index 873b1ca9b2b..188fbe7447d 100644
--- a/doc/api/projects.md
+++ b/doc/api/projects.md
@@ -185,6 +185,7 @@ Parameters:
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
+| `statistics` | boolean | no | Include project statistics |
```json
{
@@ -256,7 +257,14 @@ Parameters:
],
"only_allow_merge_if_pipeline_succeeds": false,
"only_allow_merge_if_all_discussions_are_resolved": false,
- "request_access_enabled": false
+ "request_access_enabled": false,
+ "statistics": {
+ "commit_count": 37,
+ "storage_size": 1038090,
+ "repository_size": 1038090,
+ "lfs_objects_size": 0,
+ "job_artifacts_size": 0
+ }
}
```