diff options
author | Sebastian Ziebell <sebastian.ziebell@asquera.de> | 2013-02-27 15:34:45 +0400 |
---|---|---|
committer | Sebastian Ziebell <sebastian.ziebell@asquera.de> | 2013-02-27 15:34:45 +0400 |
commit | 873db06255eae1f69644c2a0815b88c923021c8f (patch) | |
tree | 4eb4f79fa60af18bb298a2515c527a86081f274f /doc/api/groups.md | |
parent | e119b0a0cb33b1b7f2dafcf17c2a94af40aed833 (diff) |
API: groups documentation updated, functions return different status codes
Updates the API documentation of groups with infos to return codes. The function calls
in the groups API have updated documentation and return `400 Bad Request` status code
if a required attribute is missing.
Diffstat (limited to 'doc/api/groups.md')
-rw-r--r-- | doc/api/groups.md | 30 |
1 files changed, 25 insertions, 5 deletions
diff --git a/doc/api/groups.md b/doc/api/groups.md index 00a7387c76f..c97851a5db3 100644 --- a/doc/api/groups.md +++ b/doc/api/groups.md @@ -17,7 +17,14 @@ GET /groups ] ``` -## Details of group +Return values: + ++ `200 Ok` on success and list of groups ++ `401 Unauthorized` if user is not authenticated ++ `404 Not Found` if something fails + + +## Details of a group Get all details of a group. @@ -29,17 +36,30 @@ Parameters: + `id` (required) - The ID of a group +Return values: + ++ `200 Ok` on success and the details of a group ++ `401 Unauthorized` if user not authenticated ++ `404 Not Found` if group ID not found + + ## New group -Create a new project group. Available only for admin +Creates 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. ++ `name` (required) - The name of the group ++ `path` (required) - The path of the group + +Return valueS: + ++ `201 Created` on success and the newly created group ++ `400 Bad Request` if one of the required attributes not given ++ `401 Unauthorized` if user is not authenticated ++ `404 Not Found` if something fails |