API: documentation contains infos to status codes in README file.
All the info to return codes from the API functions are available in the `README.md` file as suggested.
This commit is contained in:
parent
b5ef6d2268
commit
39114d259c
11 changed files with 36 additions and 475 deletions
|
@ -17,12 +17,6 @@ GET /groups
|
|||
]
|
||||
```
|
||||
|
||||
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
|
||||
|
||||
|
@ -36,12 +30,6 @@ 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
|
||||
|
||||
|
@ -56,10 +44,3 @@ Parameters:
|
|||
+ `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
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue