diff options
author | jozefvaclavik <jozef.vaclavik@bro-coders.com> | 2012-10-12 10:38:15 +0300 |
---|---|---|
committer | jozefvaclavik <jozef.vaclavik@bro-coders.com> | 2012-10-12 10:38:15 +0300 |
commit | d0000e5c189534468da41205a1d5ad61f5c26547 (patch) | |
tree | 5258687152d5d04cc42a1f3837dd9ae445b6503e /doc | |
parent | cfbd0b4f26224d0af9fa1366f7d83036aea2c15d (diff) | |
download | gitlab-ce-d0000e5c189534468da41205a1d5ad61f5c26547.tar.gz |
Update doc/api/projects.md for hooks API
Added documentation for getting project hook and editing project hook.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/api/projects.md | 36 |
1 files changed, 34 insertions, 2 deletions
diff --git a/doc/api/projects.md b/doc/api/projects.md index d06a41c2d74..fdedf904a3a 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -196,9 +196,9 @@ Parameters: Status code `200` will be returned on success. -## Get project hooks +## List project hooks -Get hooks for project +Get list for project hooks ``` GET /projects/:id/hooks @@ -210,6 +210,21 @@ Parameters: Will return hooks with status `200 OK` on success, or `404 Not found` on fail. +## Get project hook + +Get hook for project + +``` +GET /projects/:id/hooks/:hook_id +``` + +Parameters: + ++ `id` (required) - The ID or code name of a project ++ `hook_id` (required) - The ID of a project hook + +Will return hook with status `200 OK` on success, or `404 Not found` on fail. + ## Add project hook Add hook to project @@ -225,6 +240,23 @@ Parameters: Will return status `201 Created` on success, or `404 Not found` on fail. +## Edit project hook + +Edit hook for project + +``` +PUT /projects/:id/hooks/:hook_id +``` + +Parameters: + ++ `id` (required) - The ID or code name of a project ++ `hook_id` (required) - The ID of a project hook ++ `url` (required) - The hook URL + +Will return status `201 Created` on success, or `404 Not found` on fail. + + ## Delete project hook Delete hook from project |