diff options
| author | Oleksii Shkurupii <Oleksii.Shkurupii@playtech.com> | 2021-03-15 18:10:03 +0200 |
|---|---|---|
| committer | Nejc Habjan <hab.nejc@gmail.com> | 2021-05-07 00:47:11 +0200 |
| commit | e444b39f9423b4a4c85cdb199afbad987df026f1 (patch) | |
| tree | 6aabf2f22b5134ad6291209b4792446010e50999 /docs/gl_objects | |
| parent | 0d3b8aea752f487db22f22be87de3cde247f9ffb (diff) | |
| download | gitlab-e444b39f9423b4a4c85cdb199afbad987df026f1.tar.gz | |
feat: add feature to get inherited member for project/group
Diffstat (limited to 'docs/gl_objects')
| -rw-r--r-- | docs/gl_objects/groups.rst | 14 | ||||
| -rw-r--r-- | docs/gl_objects/projects.rst | 15 |
2 files changed, 23 insertions, 6 deletions
diff --git a/docs/gl_objects/groups.rst b/docs/gl_objects/groups.rst index 1880a6b..cd8ab45 100644 --- a/docs/gl_objects/groups.rst +++ b/docs/gl_objects/groups.rst @@ -225,7 +225,9 @@ Reference + :class:`gitlab.v4.objects.GroupMember` + :class:`gitlab.v4.objects.GroupMemberManager` + + :class:`gitlab.v4.objects.GroupMemberAllManager` + :attr:`gitlab.v4.objects.Group.members` + + :attr:`gitlab.v4.objects.Group.members_all` * GitLab API: https://docs.gitlab.com/ce/api/groups.html @@ -233,19 +235,25 @@ Reference Examples -------- -List group members:: +List only direct group members:: members = group.members.list() List the group members recursively (including inherited members through ancestor groups):: - members = group.members.all(all=True) + members = group.members_all.list(all=True) + # or + members = group.members.all(all=True) # Deprecated -Get a group member:: +Get only direct group member:: members = group.members.get(member_id) +Get a member of a group, including members inherited through ancestor groups:: + + members = group.members_all.get(member_id) + Add a member to the group:: member = group.members.create({'user_id': user_id, diff --git a/docs/gl_objects/projects.rst b/docs/gl_objects/projects.rst index e61bb6a..42dbedf 100644 --- a/docs/gl_objects/projects.rst +++ b/docs/gl_objects/projects.rst @@ -502,30 +502,39 @@ Reference + :class:`gitlab.v4.objects.ProjectMember` + :class:`gitlab.v4.objects.ProjectMemberManager` + + :class:`gitlab.v4.objects.ProjectMemberAllManager` + :attr:`gitlab.v4.objects.Project.members` + + :attr:`gitlab.v4.objects.Project.members_all` * GitLab API: https://docs.gitlab.com/ce/api/members.html Examples -------- -List the project members:: +List only direct project members:: members = project.members.list() List the project members recursively (including inherited members through ancestor groups):: - members = project.members.all(all=True) + members = project.members_all.list(all=True) + # or + members = project.members.all(all=True) # Deprecated Search project members matching a query string:: members = project.members.list(query='bar') -Get a single project member:: +Get only direct project member:: member = project.members.get(user_id) +Get a member of a project, including members inherited through ancestor groups:: + + members = project.members_all.get(member_id) + + Add a project member:: member = project.members.create({'user_id': user.id, 'access_level': |