summaryrefslogtreecommitdiff
path: root/docs/gl_objects/projects.rst
diff options
context:
space:
mode:
authorGauvain Pocentek <gauvain@pocentek.net>2016-07-17 07:41:48 +0200
committerGauvain Pocentek <gauvain@pocentek.net>2016-07-17 07:41:48 +0200
commitb21dca0acb2c12add229a1742e0c552aa50618c1 (patch)
tree25d0303c7e88b8588f71aa30c9ef0ec672d27e08 /docs/gl_objects/projects.rst
parent63f0c4d21e14b06e8a70e9b752262399e2195b31 (diff)
downloadgitlab-b21dca0acb2c12add229a1742e0c552aa50618c1.tar.gz
docs: document hooks API
Diffstat (limited to 'docs/gl_objects/projects.rst')
-rw-r--r--docs/gl_objects/projects.rst37
1 files changed, 37 insertions, 0 deletions
diff --git a/docs/gl_objects/projects.rst b/docs/gl_objects/projects.rst
index bd56fba..d0c0d27 100644
--- a/docs/gl_objects/projects.rst
+++ b/docs/gl_objects/projects.rst
@@ -143,3 +143,40 @@ Share the project with a group:
.. literalinclude:: projects.py
:start-after: # share
:end-before: # end share
+
+Hooks
+-----
+
+Use :class:`~gitlab.objects.ProjectHook` objects to manipulate projects
+hooks. The :attr:`gitlab.Gitlab.project_hooks` and :attr:`Project.hooks
+<gitlab.objects.Projects.hooks>` manager objects provide helper functions.
+
+List the project hooks:
+
+.. literalinclude:: projects.py
+ :start-after: # hook list
+ :end-before: # end hook list
+
+Get a project hook
+
+.. literalinclude:: projects.py
+ :start-after: # hook get
+ :end-before: # end hook get
+
+Create a project hook:
+
+.. literalinclude:: projects.py
+ :start-after: # hook create
+ :end-before: # end hook create
+
+Update a project hook:
+
+.. literalinclude:: projects.py
+ :start-after: # hook update
+ :end-before: # end hook update
+
+Delete a project hook:
+
+.. literalinclude:: projects.py
+ :start-after: # hook delete
+ :end-before: # end hook delete