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.
This commit is contained in:
Sebastian Ziebell 2013-02-27 12:34:45 +01:00
parent e119b0a0cb
commit 873db06255
3 changed files with 44 additions and 7 deletions

View file

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