Skip to content

Commit

Permalink
docs: add project members doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Gauvain Pocentek committed Jul 16, 2016
1 parent 2df4c9e commit dcf31a4
Show file tree
Hide file tree
Showing 2 changed files with 83 additions and 0 deletions.
40 changes: 40 additions & 0 deletions docs/gl_objects/projects.py
Expand Up @@ -65,3 +65,43 @@
# or
project.events.list()
# end events list

# members list
members = gl.project_members.list()
# or
members = project.members.list()
# end members list

# members search
members = gl.project_members.list(query='foo')
# or
members = project.members.list(query='bar')
# end members search

# members get
member = gl.project_members.get(1)
# or
member = project.members.get(1)
# end members get

# members add
member = gl.project_members.create({'user_id': user.id, 'access_level':
gitlab.Group.DEVELOPER_ACCESS},
project_id=1)
# or
member = project.members.create({'user_id': user.id, 'access_level':
gitlab.Group.DEVELOPER_ACCESS})
# end members add

# members update
member.access_level = gitlab.Group.MASTER_ACCESS
member.save()
# end members update

# members delete
gl.project_members.delete(user.id, project_id=1)
# or
project.members.delete(user.id)
# or
member.delete()
# end members delete
43 changes: 43 additions & 0 deletions docs/gl_objects/projects.rst
Expand Up @@ -94,3 +94,46 @@ List the project events:
.. literalinclude:: projects.py
:start-after: # events list
:end-before: # end events list

Team members
------------

Use :class:`~gitlab.objects.ProjectMember` objects to manipulate projects
members. The :attr:`gitlab.Gitlab.project_members` and :attr:`Project.members
<gitlab.objects.Projects.members>` manager objects provide helper functions.

List the project members:

.. literalinclude:: projects.py
:start-after: # members list
:end-before: # end members list

Search project members matching a query string:

.. literalinclude:: projects.py
:start-after: # members search
:end-before: # end members search

Get a single project member:

.. literalinclude:: projects.py
:start-after: # members get
:end-before: # end members get

Add a project member:

.. literalinclude:: projects.py
:start-after: # members add
:end-before: # end members add

Modify a project member (change the access level):

.. literalinclude:: projects.py
:start-after: # members update
:end-before: # end members update

Remove a member from the project team:

.. literalinclude:: projects.py
:start-after: # members delete
:end-before: # end members delete

0 comments on commit dcf31a4

Please sign in to comment.