diff options
author | Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com> | 2015-02-03 17:54:33 -0800 |
---|---|---|
committer | Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com> | 2015-02-03 17:54:33 -0800 |
commit | 635ebac606d77eae03ce2e2a8f0a814ad4c79177 (patch) | |
tree | 8f3047074880166e53edb987df8ba4295d374c3d /doc/api | |
parent | ac7af45d8987422c2a529d3d87eae6d9bd608e12 (diff) | |
parent | 704922c855a9741b5495db56ac266788a9c25c33 (diff) | |
download | gitlab-ce-635ebac606d77eae03ce2e2a8f0a814ad4c79177.tar.gz |
Merge branch 'master' into mwessel/gitlab-ce-configure-protection
Diffstat (limited to 'doc/api')
-rw-r--r-- | doc/api/groups.md | 32 |
1 files changed, 26 insertions, 6 deletions
diff --git a/doc/api/groups.md b/doc/api/groups.md index e6893d71774..9f01b550641 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 @@ -32,7 +32,7 @@ GET /groups/:id Parameters: -- `id` (required) - The ID of a group +- `id` (required) - The ID or path of a group ## New group @@ -58,7 +58,7 @@ POST /groups/:id/projects/:project_id Parameters: -- `id` (required) - The ID of a group +- `id` (required) - The ID or path of a group - `project_id` (required) - The ID of a project ## Remove group @@ -71,7 +71,27 @@ DELETE /groups/:id Parameters: -- `id` (required) - The ID of a user group +- `id` (required) - The ID or path 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 @@ -128,7 +148,7 @@ POST /groups/:id/members Parameters: -- `id` (required) - The ID of a group +- `id` (required) - The ID or path of a group - `user_id` (required) - The ID of a user to add - `access_level` (required) - Project access level @@ -142,5 +162,5 @@ DELETE /groups/:id/members/:user_id Parameters: -- `id` (required) - The ID of a user group +- `id` (required) - The ID or path of a user group - `user_id` (required) - The ID of a group member |