diff options
author | Christian Simon <cs@f03.eu> | 2013-02-01 17:59:22 +0400 |
---|---|---|
committer | Christian Simon <cs@f03.eu> | 2013-02-01 17:59:22 +0400 |
commit | fc0c69287069af9a47176abb1488f653f91eebdb (patch) | |
tree | 80d64fff376bb30d9454da083938f5c8f2159e06 /doc/api/groups.md | |
parent | 8edc6b6a8c240322499356df96e1199bb6bbc872 (diff) |
Add docs/tests for groups api
Diffstat (limited to 'doc/api/groups.md')
-rw-r--r-- | doc/api/groups.md | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/doc/api/groups.md b/doc/api/groups.md new file mode 100644 index 00000000000..00a7387c76f --- /dev/null +++ b/doc/api/groups.md @@ -0,0 +1,45 @@ +## List project groups + +Get a list of groups. (As user: my groups, as admin: all groups) + +``` +GET /groups +``` + +```json +[ + { + "id": 1, + "name": "Foobar Group", + "path": "foo-bar", + "owner_id": 18 + } +] +``` + +## Details of group + +Get all details of a group. + +``` +GET /groups/:id +``` + +Parameters: + ++ `id` (required) - The ID of a group + +## New group + +Create a new project group. Available only for admin + +``` +POST /groups +``` + +Parameters: ++ `name` (required) - Email ++ `path` - Password + +Will return created group with status `201 Created` on success, or `404 Not found` on fail. + |