diff options
author | Job van der Voort <jobvandervoort@gmail.com> | 2015-02-02 10:00:05 -0800 |
---|---|---|
committer | Job van der Voort <jobvandervoort@gmail.com> | 2015-02-02 10:00:05 -0800 |
commit | 561a7153082ef6cad7ec244d7881b8ddd35b9f8c (patch) | |
tree | 0c3e81949011ef720164c325bca49a4be7d5df81 /doc/api | |
parent | 47f3218e6fa8e1f475e41f0f927a358ebd7f102a (diff) | |
download | gitlab-ce-561a7153082ef6cad7ec244d7881b8ddd35b9f8c.tar.gz |
add clear documentation on searching between groups
Diffstat (limited to 'doc/api')
-rw-r--r-- | doc/api/groups.md | 22 |
1 files changed, 21 insertions, 1 deletions
diff --git a/doc/api/groups.md b/doc/api/groups.md index e6893d71774..9217c7a7f24 100644 --- a/doc/api/groups.md +++ b/doc/api/groups.md @@ -20,7 +20,7 @@ GET /groups ] ``` -You can search for groups by name or path with: `/groups?search=Rails` +You can search for groups by name or path, see below. ## Details of a group @@ -73,6 +73,26 @@ Parameters: - `id` (required) - The ID of a user group +## Search for group + +Get all groups that match your string in their name or path. + +``` +GET /groups?search=foobar +``` + +```json +[ + { + "id": 1, + "name": "Foobar Group", + "path": "foo-bar", + "owner_id": 18, + "description": "An interesting group" + } +] +``` + ## Group members **Group access levels** |