summaryrefslogtreecommitdiff
path: root/doc/api/groups.md
diff options
context:
space:
mode:
authorMarko, Peter <peter.marko@siemens.com>2018-06-08 20:37:19 +0200
committerMarko, Peter <peter.marko@siemens.com>2018-06-12 08:16:01 +0200
commit79033a5f678c05c640d0b0cb7b53909ae2b5e221 (patch)
tree65120efc093d2a35e50984b433f004242d904803 /doc/api/groups.md
parenta8da4f3fa810ed0931ee8f54ac8123fb2f484830 (diff)
downloadgitlab-ce-79033a5f678c05c640d0b0cb7b53909ae2b5e221.tar.gz
Add id group api sorting option
With introduction of subgroups, many groups may have the same name and/or path, thus further sorting options are necessary. Signed-off-by: Marko, Peter <peter.marko@siemens.com>
Diffstat (limited to 'doc/api/groups.md')
-rw-r--r--doc/api/groups.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/api/groups.md b/doc/api/groups.md
index 96842ef330f..a48905f2f15 100644
--- a/doc/api/groups.md
+++ b/doc/api/groups.md
@@ -12,7 +12,7 @@ Parameters:
| `skip_groups` | array of integers | no | Skip the group IDs passed |
| `all_available` | boolean | no | Show all the groups you have access to (defaults to `false` for authenticated users, `true` for admin) |
| `search` | string | no | Return the list of authorized groups matching the search criteria |
-| `order_by` | string | no | Order groups by `name` or `path`. Default is `name` |
+| `order_by` | string | no | Order groups by `name`, `path` or `id`. Default is `name` |
| `sort` | string | no | Order groups in `asc` or `desc` order. Default is `asc` |
| `statistics` | boolean | no | Include group statistics (admins only) |
| `with_custom_attributes` | boolean | no | Include [custom attributes](custom_attributes.md) in response (admins only) |
@@ -96,7 +96,7 @@ Parameters:
| `skip_groups` | array of integers | no | Skip the group IDs passed |
| `all_available` | boolean | no | Show all the groups you have access to (defaults to `false` for authenticated users, `true` for admin) |
| `search` | string | no | Return the list of authorized groups matching the search criteria |
-| `order_by` | string | no | Order groups by `name` or `path`. Default is `name` |
+| `order_by` | string | no | Order groups by `name`, `path` or `id`. Default is `name` |
| `sort` | string | no | Order groups in `asc` or `desc` order. Default is `asc` |
| `statistics` | boolean | no | Include group statistics (admins only) |
| `with_custom_attributes` | boolean | no | Include [custom attributes](custom_attributes.md) in response (admins only) |