diff options
author | Achilleas Pipinellis <axil@gitlab.com> | 2017-10-24 12:38:54 +0300 |
---|---|---|
committer | Achilleas Pipinellis <axil@gitlab.com> | 2017-10-24 12:38:54 +0300 |
commit | a65b29749140323168415f178a698f5df8ab6651 (patch) | |
tree | 3e02d92285fd9774ba85db0203afc75906451331 | |
parent | 3dcdd4a1e8533cac55805d2242446cb2e12b21e9 (diff) | |
parent | abfecabd0d3399e6dc67c24c511dae2b7e9f31bb (diff) |
Merge branch 'api-doc-group-statistics' into 'master'
Update groups API documentation
Closes #38922
See merge request gitlab-org/gitlab-ce!15024
-rw-r--r-- | changelogs/unreleased/api-doc-group-statistics.yml | 5 | ||||
-rw-r--r-- | doc/api/groups.md | 32 |
2 files changed, 37 insertions, 0 deletions
diff --git a/changelogs/unreleased/api-doc-group-statistics.yml b/changelogs/unreleased/api-doc-group-statistics.yml new file mode 100644 index 00000000000..385ff978024 --- /dev/null +++ b/changelogs/unreleased/api-doc-group-statistics.yml @@ -0,0 +1,5 @@ +--- +title: Update the groups API documentation +merge_request: 15024 +author: Robert Schilling +type: fixed diff --git a/doc/api/groups.md b/doc/api/groups.md index c2daa8bc029..99d200c9c93 100644 --- a/doc/api/groups.md +++ b/doc/api/groups.md @@ -40,6 +40,38 @@ GET /groups ] ``` +When adding the parameter `statistics=true` and the authenticated user is an admin, additional group statistics are returned. + +``` +GET /groups?statistics=true +``` + +```json +[ + { + "id": 1, + "name": "Foobar Group", + "path": "foo-bar", + "description": "An interesting group", + "visibility": "public", + "lfs_enabled": true, + "avatar_url": "http://localhost:3000/uploads/group/avatar/1/foo.jpg", + "web_url": "http://localhost:3000/groups/foo-bar", + "request_access_enabled": false, + "full_name": "Foobar Group", + "full_path": "foo-bar", + "parent_id": null, + "statistics": { + "storage_size" : 212, + "repository_size" : 33, + "lfs_objects_size" : 123, + "job_artifacts_size" : 57 + + } + } +] +``` + You can search for groups by name or path, see below. ## List a group's projects |