deac/gitlabhq
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

API: system hooks API functions and documentation updated

Browse source 
* updated system hooks documentation and code comments
* fixed access to system hooks if no user given resulting in a `500 Server Error`
* added tests
This commit is contained in:
Sebastian Ziebell 2013-03-07 17:56:11 +01:00
parent ecf53bb9e6
commit 32f1eaaf0f
3 changed files with 36 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

12
doc/api/system_hooks.md
View file

@ -8,7 +8,10 @@ Get list of system hooks
GET /hooks
```
Will return hooks with status `200 OK` on success, or `404 Not found` on fail.
Parameters:
+ **none**
## Add new system hook hook
@ -20,7 +23,6 @@ Parameters:
+ `url` (required) - The hook URL
Will return status `201 Created` on success, or `404 Not found` on fail.
## Test system hook
@ -32,10 +34,12 @@ Parameters:
+ `id` (required) - The ID of hook
Will return hook with status `200 OK` on success, or `404 Not found` on fail.
## Delete system hook
Deletes a system hook. This is an idempotent API function and returns `200 Ok` even if the hook
is not available. If the hook is deleted it is also returned as JSON.
```
DELETE /hooks/:id
```
@ -43,5 +47,3 @@ DELETE /hooks/:id
Parameters:
+ `id` (required) - The ID of hook
Will return status `200 OK` on success, or `404 Not found` on fail.