summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGauvain Pocentek <gauvain@pocentek.net>2017-09-21 22:17:06 +0200
committerGauvain Pocentek <gauvain@pocentek.net>2017-09-21 22:17:06 +0200
commita346f921560e6eb52f52ed0c660ecae7fcd73b6a (patch)
treef35db0a74e02824cfb28fb80739705b6ef45363f
parent80351caf6dec0f1f2ebaccacd88d7175676e340f (diff)
downloadgitlab-a346f921560e6eb52f52ed0c660ecae7fcd73b6a.tar.gz
Add missing doc file
-rw-r--r--docs/gl_objects/protected_branches.rst44
1 files changed, 44 insertions, 0 deletions
diff --git a/docs/gl_objects/protected_branches.rst b/docs/gl_objects/protected_branches.rst
new file mode 100644
index 0000000..4a6c837
--- /dev/null
+++ b/docs/gl_objects/protected_branches.rst
@@ -0,0 +1,44 @@
+##################
+Protected branches
+##################
+
+You can define a list of protected branch names on a repository. Names can use
+wildcards (``*``).
+
+References
+----------
+
+* v4 API:
+
+ + :class:`gitlab.v4.objects.ProjectProtectedBranch`
+ + :class:`gitlab.v4.objects.ProjectProtectedBranchManager`
+ + :attr:`gitlab.v4.objects.Project.protectedbranches`
+
+* GitLab API: https://docs.gitlab.com/ce/api/protected_branches.html#protected-branches-api
+
+Examples
+--------
+
+Get the list of protected branches for a project:
+
+.. literalinclude:: branches.py
+ :start-after: # p_branch list
+ :end-before: # end p_branch list
+
+Get a single protected branch:
+
+.. literalinclude:: branches.py
+ :start-after: # p_branch get
+ :end-before: # end p_branch get
+
+Create a protected branch:
+
+.. literalinclude:: branches.py
+ :start-after: # p_branch create
+ :end-before: # end p_branch create
+
+Delete a protected branch:
+
+.. literalinclude:: branches.py
+ :start-after: # p_branch delete
+ :end-before: # end p_branch delete