diff options
| author | Sebastian Ziebell <sebastian.ziebell@asquera.de> | 2013-03-07 20:56:11 +0400 |
|---|---|---|
| committer | Sebastian Ziebell <sebastian.ziebell@asquera.de> | 2013-03-07 20:56:11 +0400 |
| commit | 32f1eaaf0f966ccc45635693679bcc8658e71815 (patch) | |
| tree | fb2b5dc19ea14ae1e9fb3f50b896e4e047f8e21d /doc/api/system_hooks.md | |
| parent | ecf53bb9e616b724bafc939d5e74744e774e3fd2 (diff) | |
API: system hooks API functions and documentation updated
* updated system hooks documentation and code comments
* fixed access to system hooks if no user given resulting in a `500 Server Error`
* added tests
Diffstat (limited to 'doc/api/system_hooks.md')
| -rw-r--r-- | doc/api/system_hooks.md | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/doc/api/system_hooks.md b/doc/api/system_hooks.md index f6e11ed238e..dca22c43f83 100644 --- a/doc/api/system_hooks.md +++ b/doc/api/system_hooks.md @@ -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.
\ No newline at end of file |