Skip to content

Commit dcf31a4

Browse files
author
Gauvain Pocentek
committed
docs: add project members doc
1 parent 2df4c9e commit dcf31a4

File tree

2 files changed

+83
-0
lines changed

2 files changed

+83
-0
lines changed

docs/gl_objects/projects.py

+40
Original file line numberDiff line numberDiff line change
@@ -65,3 +65,43 @@
6565
# or
6666
project.events.list()
6767
# end events list
68+
69+
# members list
70+
members = gl.project_members.list()
71+
# or
72+
members = project.members.list()
73+
# end members list
74+
75+
# members search
76+
members = gl.project_members.list(query='foo')
77+
# or
78+
members = project.members.list(query='bar')
79+
# end members search
80+
81+
# members get
82+
member = gl.project_members.get(1)
83+
# or
84+
member = project.members.get(1)
85+
# end members get
86+
87+
# members add
88+
member = gl.project_members.create({'user_id': user.id, 'access_level':
89+
gitlab.Group.DEVELOPER_ACCESS},
90+
project_id=1)
91+
# or
92+
member = project.members.create({'user_id': user.id, 'access_level':
93+
gitlab.Group.DEVELOPER_ACCESS})
94+
# end members add
95+
96+
# members update
97+
member.access_level = gitlab.Group.MASTER_ACCESS
98+
member.save()
99+
# end members update
100+
101+
# members delete
102+
gl.project_members.delete(user.id, project_id=1)
103+
# or
104+
project.members.delete(user.id)
105+
# or
106+
member.delete()
107+
# end members delete

docs/gl_objects/projects.rst

+43
Original file line numberDiff line numberDiff line change
@@ -94,3 +94,46 @@ List the project events:
9494
.. literalinclude:: projects.py
9595
:start-after: # events list
9696
:end-before: # end events list
97+
98+
Team members
99+
------------
100+
101+
Use :class:`~gitlab.objects.ProjectMember` objects to manipulate projects
102+
members. The :attr:`gitlab.Gitlab.project_members` and :attr:`Project.members
103+
<gitlab.objects.Projects.members>` manager objects provide helper functions.
104+
105+
List the project members:
106+
107+
.. literalinclude:: projects.py
108+
:start-after: # members list
109+
:end-before: # end members list
110+
111+
Search project members matching a query string:
112+
113+
.. literalinclude:: projects.py
114+
:start-after: # members search
115+
:end-before: # end members search
116+
117+
Get a single project member:
118+
119+
.. literalinclude:: projects.py
120+
:start-after: # members get
121+
:end-before: # end members get
122+
123+
Add a project member:
124+
125+
.. literalinclude:: projects.py
126+
:start-after: # members add
127+
:end-before: # end members add
128+
129+
Modify a project member (change the access level):
130+
131+
.. literalinclude:: projects.py
132+
:start-after: # members update
133+
:end-before: # end members update
134+
135+
Remove a member from the project team:
136+
137+
.. literalinclude:: projects.py
138+
:start-after: # members delete
139+
:end-before: # end members delete

0 commit comments

Comments
 (0)