diff options
| author | Nejc Habjan <hab.nejc@gmail.com> | 2021-05-29 23:47:46 +0200 |
|---|---|---|
| committer | John Villalovos <john@sodarock.com> | 2021-05-29 21:06:15 -0700 |
| commit | 1b70580020825adf2d1f8c37803bc4655a97be41 (patch) | |
| tree | 8e754db6fb365ce7c7fa01e51e527e5fdded630f /docs/gl_objects | |
| parent | 237b97ceb0614821e59ea041f43a9806b65cdf8c (diff) | |
| download | gitlab-1b70580020825adf2d1f8c37803bc4655a97be41.tar.gz | |
feat(objects): add support for descendant groups API
Diffstat (limited to 'docs/gl_objects')
| -rw-r--r-- | docs/gl_objects/groups.rst | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/gl_objects/groups.rst b/docs/gl_objects/groups.rst index 9f1b049..596db0a 100644 --- a/docs/gl_objects/groups.rst +++ b/docs/gl_objects/groups.rst @@ -167,6 +167,31 @@ List the subgroups for a group:: real_group = gl.groups.get(subgroup_id, lazy=True) real_group.issues.list() +Descendant Groups +================= + +Reference +--------- + +* v4 API: + + + :class:`gitlab.v4.objects.GroupDescendantGroup` + + :class:`gitlab.v4.objects.GroupDescendantGroupManager` + + :attr:`gitlab.v4.objects.Group.descendant_groups` + +Examples +-------- + +List the descendant groups of a group:: + + descendant_groups = group.descendant_groups.list() + +.. note:: + + Like the ``GroupSubgroup`` objects described above, ``GroupDescendantGroup`` + objects do not expose the same API as the ``Group`` objects. Create a new + ``Group`` object instead if needed, as shown in the subgroup example. + Group custom attributes ======================= |
