summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarin Jankovski <marin@gitlab.com>2015-02-02 18:05:11 +0000
committerMarin Jankovski <marin@gitlab.com>2015-02-02 18:05:11 +0000
commit1bdd3ce4633049d8f86582bf4b0209d6c03074d0 (patch)
tree0a224034e52a7abdc2d6f0b9ebf11b422c96213c
parente0ac740962e91b68dcee673fe2414c0515d0ab56 (diff)
parent561a7153082ef6cad7ec244d7881b8ddd35b9f8c (diff)
downloadgitlab-ce-1bdd3ce4633049d8f86582bf4b0209d6c03074d0.tar.gz
Merge branch 'search-group' into 'master'
Search group documentation See merge request !1455
-rw-r--r--doc/api/groups.md22
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**