From 561a7153082ef6cad7ec244d7881b8ddd35b9f8c Mon Sep 17 00:00:00 2001
From: Job van der Voort <jobvandervoort@gmail.com>
Date: Mon, 2 Feb 2015 10:00:05 -0800
Subject: add clear documentation on searching between groups

---
 doc/api/groups.md | 22 +++++++++++++++++++++-
 1 file changed, 21 insertions(+), 1 deletion(-)

(limited to 'doc/api/groups.md')

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**
-- 
cgit v1.2.1