Commit a65b2974 authored by Achilleas Pipinellis's avatar Achilleas Pipinellis

Merge branch 'api-doc-group-statistics' into 'master'

Update groups API documentation

Closes #38922

See merge request gitlab-org/gitlab-ce!15024
parents 3dcdd4a1 abfecabd
---
title: Update the groups API documentation
merge_request: 15024
author: Robert Schilling
type: fixed
...@@ -40,6 +40,38 @@ GET /groups ...@@ -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. You can search for groups by name or path, see below.
## List a group's projects ## List a group's projects
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment