diff options
Diffstat (limited to 'doc/api/groups.md')
| -rw-r--r-- | doc/api/groups.md | 66 |
1 files changed, 46 insertions, 20 deletions
diff --git a/doc/api/groups.md b/doc/api/groups.md index fb77901c65b..f5f5d769050 100644 --- a/doc/api/groups.md +++ b/doc/api/groups.md @@ -8,12 +8,12 @@ GET /groups ```json [ - { - "id": 1, - "name": "Foobar Group", - "path": "foo-bar", - "owner_id": 18 - } + { + "id": 1, + "name": "Foobar Group", + "path": "foo-bar", + "owner_id": 18 + } ] ``` @@ -57,8 +57,34 @@ Parameters: + `project_id` (required) - The ID of a project +## Remove group + +Removes group with all projects inside. + +``` +DELETE /groups/:id +``` + +Parameters: + ++ `id` (required) - The ID of a user group + + ## Group members + +**Group access levels** + +The group access levels are defined in the `Gitlab::Access` module. Currently, these levels are recognized: + +``` + GUEST = 10 + REPORTER = 20 + DEVELOPER = 30 + MASTER = 40 + OWNER = 50 +``` + ### List group members Get a list of group members viewable by the authenticated user. @@ -70,22 +96,22 @@ GET /groups/:id/members ```json [ { - id: 1, - username: "raymond_smith", - email: "ray@smith.org", - name: "Raymond Smith", - state: "active", - created_at: "2012-10-22T14:13:35Z", - access_level: 30 + "id": 1, + "username": "raymond_smith", + "email": "ray@smith.org", + "name": "Raymond Smith", + "state": "active", + "created_at": "2012-10-22T14:13:35Z", + "access_level": 30 }, { - id: 2, - username: "john_doe", - email: "joh@doe.org", - name: "John Doe", - state: "active", - created_at: "2012-10-22T14:13:35Z", - access_level: 30 + "id": 2, + "username": "john_doe", + "email": "joh@doe.org", + "name": "John Doe", + "state": "active", + "created_at": "2012-10-22T14:13:35Z", + "access_level": 30 } ] ``` |