diff options
| author | Phil Hughes <me@iamphill.com> | 2016-11-24 11:32:59 +0000 |
|---|---|---|
| committer | Phil Hughes <me@iamphill.com> | 2016-11-24 11:32:59 +0000 |
| commit | 8c4f4afd6dd6d382aab2d6b992b6ffe3e60f91af (patch) | |
| tree | 37d3ff76dc31e7fcfa63eb8c2f54c9d84eb9b88a /doc/api/groups.md | |
| parent | 03a235783f697572fe201332cb82746401a01daf (diff) | |
| parent | 3e44ed3e2bf75bb14a2d8b0466b3d92afd0ea067 (diff) | |
| download | gitlab-ce-autocomplete-space-prefix.tar.gz | |
Merge branch 'master' into autocomplete-space-prefixautocomplete-space-prefix
Diffstat (limited to 'doc/api/groups.md')
| -rw-r--r-- | doc/api/groups.md | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/doc/api/groups.md b/doc/api/groups.md index 45a3118f27a..5e6f498c365 100644 --- a/doc/api/groups.md +++ b/doc/api/groups.md @@ -6,8 +6,13 @@ Get a list of groups. (As user: my groups or all available, as admin: all groups Parameters: -- `all_available` (optional) - if passed, show all groups you have access to -- `skip_groups` (optional)(array of group IDs) - if passed, skip groups +| Attribute | Type | Required | Description | +| --------- | ---- | -------- | ----------- | +| `skip_groups` | array of integers | no | Skip the group IDs passes | +| `all_available` | boolean | no | Show all the groups you have access to | +| `search` | string | no | Return list of authorized groups matching the search criteria | +| `order_by` | string | no | Order groups by `name` or `path`. Default is `name` | +| `sort` | string | no | Order groups in `asc` or `desc` order. Default is `asc` | ``` GET /groups |