summaryrefslogtreecommitdiff
path: root/docs/gl_objects
diff options
context:
space:
mode:
authorGauvain Pocentek <gauvain@pocentek.net>2016-07-16 19:28:25 +0200
committerGauvain Pocentek <gauvain@pocentek.net>2016-07-16 19:28:25 +0200
commitdcf31a425217efebe56d4cbc8250dceb3844b2fa (patch)
tree9a2bf63fbd2430c4c43274a91cc4cffe979e8ae4 /docs/gl_objects
parent2df4c9e52a89de7256dacef9cb567ea1b2e056f4 (diff)
downloadgitlab-dcf31a425217efebe56d4cbc8250dceb3844b2fa.tar.gz
docs: add project members doc
Diffstat (limited to 'docs/gl_objects')
-rw-r--r--docs/gl_objects/projects.py40
-rw-r--r--docs/gl_objects/projects.rst43
2 files changed, 83 insertions, 0 deletions
diff --git a/docs/gl_objects/projects.py b/docs/gl_objects/projects.py
index 24ce6d6..cd13675 100644
--- a/docs/gl_objects/projects.py
+++ b/docs/gl_objects/projects.py
@@ -65,3 +65,43 @@ gl.project_events.list(project_id=1)
# 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
diff --git a/docs/gl_objects/projects.rst b/docs/gl_objects/projects.rst
index f800499..3bdeff4 100644
--- a/docs/gl_objects/projects.rst
+++ b/docs/gl_objects/projects.rst
@@ -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