summaryrefslogtreecommitdiff
path: root/docs/gl_objects
diff options
context:
space:
mode:
authorNejc Habjan <hab.nejc@gmail.com>2021-10-11 23:32:10 +0200
committerNejc Habjan <hab.nejc@gmail.com>2021-10-14 23:41:12 +0200
commite1828b15ac96844307dadba1440b22a836d4b12b (patch)
treeaa253d8fbfc08ddff400aa4bf04df0dce6e8ad4d /docs/gl_objects
parent79785f0bee2ef6cc9872f816a78c13583dfb77ab (diff)
downloadgitlab-feat/starred-projects.tar.gz
feat(objects): list starred projects of a userfeat/starred-projects
Diffstat (limited to 'docs/gl_objects')
-rw-r--r--docs/gl_objects/projects.rst5
-rw-r--r--docs/gl_objects/users.rst10
2 files changed, 14 insertions, 1 deletions
diff --git a/docs/gl_objects/projects.rst b/docs/gl_objects/projects.rst
index 0b251ea..c00c554 100644
--- a/docs/gl_objects/projects.rst
+++ b/docs/gl_objects/projects.rst
@@ -57,6 +57,11 @@ Results can also be sorted using the following parameters:
.. note::
+ To list the starred projects of another user, see the
+ :ref:`Users API docs <users_examples>`.
+
+.. note::
+
Fetching a list of projects, doesn't include all attributes of all projects.
To retrieve all attributes, you'll need to fetch a single project
diff --git a/docs/gl_objects/users.rst b/docs/gl_objects/users.rst
index dd6db6a..aa3a660 100644
--- a/docs/gl_objects/users.rst
+++ b/docs/gl_objects/users.rst
@@ -1,3 +1,5 @@
+.. _users_examples:
+
######################
Users and current user
######################
@@ -19,7 +21,10 @@ References
+ :class:`gitlab.v4.objects.UserManager`
+ :attr:`gitlab.Gitlab.users`
-* GitLab API: https://docs.gitlab.com/ce/api/users.html
+* GitLab API:
+
+ + https://docs.gitlab.com/ce/api/users.html
+ + https://docs.gitlab.com/ee/api/projects.html#list-projects-starred-by-a-user
Examples
--------
@@ -97,6 +102,9 @@ Get the followings of a user
user.following_users.list()
+List a user's starred projects
+
+ user.starred_projects.list()
User custom attributes
======================