Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com>2013-03-11 10:56:29 +0400
committerDmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com>2013-03-11 10:56:29 +0400
commita29c883b5b41a2340207a939cd4b32a0c2fe03ca (patch)
treee2c66dcc1dd4aa1cca9a360217a92f8d1a66c950 /doc
parent269a9859488e184768ca7d99e562b93b414f87d6 (diff)
parent562de2a438268bbc71537f2102f4ae7848aaa98e (diff)
Merge pull request #3170 from Asquera/api/system_hooks_adjustments
API: system hook request functions and documentation updated
Diffstat (limited to 'doc')
-rw-r--r--doc/api/system_hooks.md12
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