add clear documentation on searching between groups

This commit is contained in:
Job van der Voort 2015-02-02 10:00:05 -08:00
parent 47f3218e6f
commit 561a715308
1 changed files with 21 additions and 1 deletions

View File

@ -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**