Skip to content

Commit

Permalink
Add missing doc file
Browse files Browse the repository at this point in the history
  • Loading branch information
Gauvain Pocentek committed Sep 21, 2017
1 parent 80351ca commit a346f92
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions 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

0 comments on commit a346f92

Please sign in to comment.