summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGauvain Pocentek <gauvain@pocentek.net>2018-09-05 18:43:16 +0200
committerGauvain Pocentek <gauvain@pocentek.net>2018-09-05 18:43:16 +0200
commit9e60364306a894855c8e0744ed4b93cec8ea9ad0 (patch)
treebb6af683f2e36870e2470394b9f7db9eca5f7283
parent6f80380ed1de49dcc035d06408263d4961e7d18b (diff)
downloadgitlab-9e60364306a894855c8e0744ed4b93cec8ea9ad0.tar.gz
[docs] Add a note about GroupProject limited API
-rw-r--r--docs/gl_objects/groups.rst22
1 files changed, 17 insertions, 5 deletions
diff --git a/docs/gl_objects/groups.rst b/docs/gl_objects/groups.rst
index 5ef5469..ff45c9b 100644
--- a/docs/gl_objects/groups.rst
+++ b/docs/gl_objects/groups.rst
@@ -31,6 +31,15 @@ List a group's projects::
projects = group.projects.list()
+.. note::
+
+ ``GroupProject`` objects returned by this API call are very limited, and do
+ not provide all the features of ``Project`` objects. If you need to
+ manipulate projects, create a new ``Project`` object::
+
+ first_group_project = group.projects.list()[0]
+ manageable_project = gl.projects.get(first_group_project.id, lazy=True)
+
You can filter and sort the result using the following parameters:
* ``archived``: limit by archived status
@@ -76,11 +85,14 @@ List the subgroups for a group::
subgroups = group.subgroups.list()
- # The GroupSubgroup objects don't expose the same API as the Group
- # objects. If you need to manipulate a subgroup as a group, create a new
- # Group object:
- real_group = gl.groups.get(subgroup_id, lazy=True)
- real_group.issues.list()
+.. note::
+
+ The ``GroupSubgroup`` objects don't expose the same API as the ``Group``
+ objects. If you need to manipulate a subgroup as a group, create a new
+ ``Group`` object::
+
+ real_group = gl.groups.get(subgroup_id, lazy=True)
+ real_group.issues.list()
Group custom attributes
=======================