summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGauvain Pocentek <gauvain@pocentek.net>2017-11-11 09:22:43 +0100
committerGauvain Pocentek <gauvain@pocentek.net>2017-11-11 09:22:43 +0100
commit29d8d72e4ef3aaf21a45954c53b9048e61736d28 (patch)
tree0d5a7b73651bf7beadf3523363323b1064657fca
parent44a7ef6d390b534977fb14a360e551634135bc20 (diff)
downloadgitlab-29d8d72e4ef3aaf21a45954c53b9048e61736d28.tar.gz
update user docs with gitlab URLs
-rw-r--r--docs/gl_objects/users.rst19
1 files changed, 19 insertions, 0 deletions
diff --git a/docs/gl_objects/users.rst b/docs/gl_objects/users.rst
index fca7ca8..e520c9b 100644
--- a/docs/gl_objects/users.rst
+++ b/docs/gl_objects/users.rst
@@ -25,6 +25,8 @@ References
+ :class:`gitlab.v3.objects.UserManager`
+ :attr:`gitlab.Gitlab.users`
+* GitLab API: https://docs.gitlab.com/ce/api/users.html
+
Examples
--------
@@ -82,6 +84,11 @@ References
+ :class:`gitlab.v4.objects.UserCustomAttributeManager`
+ :attr:`gitlab.v4.objects.User.customattributes`
+* GitLab API: https://docs.gitlab.com/ce/api/custom_attributes.html
+
+Examples
+--------
+
List custom attributes for a user:
.. literalinclude:: users.py
@@ -118,6 +125,8 @@ References
+ :class:`gitlab.v4.objects.UserImpersonationTokenManager`
+ :attr:`gitlab.v4.objects.User.impersonationtokens`
+* GitLab API: https://docs.gitlab.com/ce/api/users.html#get-all-impersonation-tokens-of-a-user
+
List impersonation tokens for a user:
.. literalinclude:: users.py
@@ -160,6 +169,8 @@ References
+ :class:`gitlab.v3.objects.CurrentUserManager`
+ :attr:`gitlab.Gitlab.user`
+* GitLab API: https://docs.gitlab.com/ce/api/users.html
+
Examples
--------
@@ -187,6 +198,8 @@ are admin.
+ :class:`gitlab.v4.objects.UserGPGKeyManager`
+ :attr:`gitlab.v4.objects.User.gpgkeys`
+* GitLab API: https://docs.gitlab.com/ce/api/users.html#list-all-gpg-keys
+
Exemples
--------
@@ -243,6 +256,8 @@ are admin.
+ :attr:`gitlab.v3.objects.User.keys`
+ :attr:`gitlab.Gitlab.user_keys`
+* GitLab API: https://docs.gitlab.com/ce/api/users.html#list-ssh-keys
+
Exemples
--------
@@ -299,6 +314,8 @@ are admin.
+ :attr:`gitlab.v3.objects.User.emails`
+ :attr:`gitlab.Gitlab.user_emails`
+* GitLab API: https://docs.gitlab.com/ce/api/users.html#list-emails
+
Exemples
--------
@@ -341,6 +358,8 @@ References
+ :class:`gitlab.v4.objects.UserActivitiesManager`
+ :attr:`gitlab.Gitlab.user_activities`
+* GitLab API: https://docs.gitlab.com/ce/api/users.html#get-user-activities-admin-only
+
Examples
--------