Add doc for search by custom attribute

python-gitlab · Jan 1, 2018 · 2e2a78d · 2e2a78d
1 parent 65c64eb
commit 2e2a78d
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 0 deletions.
diff --git 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
@@ -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
@@ -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
 =========================