summaryrefslogtreecommitdiff
path: root/docs/gl_objects
diff options
context:
space:
mode:
authorGauvain Pocentek <gauvain@pocentek.net>2018-01-01 16:18:58 +0100
committerGauvain Pocentek <gauvain@pocentek.net>2018-01-01 16:18:58 +0100
commit2e2a78da9e3910bceb30bd9ac9e574b8b1425d05 (patch)
treefaf1347bb1e021380b60e552bb50c7d0a6211bbd /docs/gl_objects
parent65c64ebc08d75092151e828fab0fa73f5fd22e45 (diff)
downloadgitlab-2e2a78da9e3910bceb30bd9ac9e574b8b1425d05.tar.gz
Add doc for search by custom attribute
Diffstat (limited to 'docs/gl_objects')
-rw-r--r--docs/gl_objects/groups.rst5
-rw-r--r--docs/gl_objects/projects.rst5
-rw-r--r--docs/gl_objects/users.rst5
3 files changed, 15 insertions, 0 deletions
diff --git a/docs/gl_objects/groups.rst b/docs/gl_objects/groups.rst
index 9b5edb0..5536de2 100644
--- a/docs/gl_objects/groups.rst
+++ b/docs/gl_objects/groups.rst
@@ -126,6 +126,11 @@ Delete a custom attribute for a group::
# or
group.customattributes.delete(attr_key)
+Search groups by custom attribute::
+
+ group.customattributes.set('role': 'admin')
+ gl.groups.list(custom_attributes={'role': 'admin'})
+
Group members
=============
diff --git a/docs/gl_objects/projects.rst b/docs/gl_objects/projects.rst
index b7c5d78..0395950 100644
--- a/docs/gl_objects/projects.rst
+++ b/docs/gl_objects/projects.rst
@@ -207,6 +207,11 @@ Delete a custom attribute for a project::
# or
project.customattributes.delete(attr_key)
+Search projects by custom attribute::
+
+ project.customattributes.set('type': 'internal')
+ gl.projects.list(custom_attributes={'type': 'internal'})
+
Project files
=============
diff --git a/docs/gl_objects/users.rst b/docs/gl_objects/users.rst
index e57daf6..63609db 100644
--- a/docs/gl_objects/users.rst
+++ b/docs/gl_objects/users.rst
@@ -107,6 +107,11 @@ Delete a custom attribute for a user::
# or
user.customattributes.delete(attr_key)
+Search users by custom attribute::
+
+ user.customattributes.set('role': 'QA')
+ gl.users.list(custom_attributes={'role': 'QA'})
+
User impersonation tokens
=========================