BigW Consortium Gitlab

Commit d0000e5c by jozefvaclavik

Update doc/api/projects.md for hooks API

Added documentation for getting project hook and editing project hook.
parent cfbd0b4f
...@@ -196,9 +196,9 @@ Parameters: ...@@ -196,9 +196,9 @@ Parameters:
Status code `200` will be returned on success. 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 GET /projects/:id/hooks
...@@ -210,6 +210,21 @@ Parameters: ...@@ -210,6 +210,21 @@ Parameters:
Will return hooks with status `200 OK` on success, or `404 Not found` on fail. 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 project hook
Add hook to project Add hook to project
...@@ -225,6 +240,23 @@ Parameters: ...@@ -225,6 +240,23 @@ Parameters:
Will return status `201 Created` on success, or `404 Not found` on fail. 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 project hook
Delete hook from project Delete hook from project
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment