summaryrefslogtreecommitdiff
path: root/docs/gl_objects/groups.rst
diff options
context:
space:
mode:
authorGauvain Pocentek <gauvain@pocentek.net>2018-01-01 15:44:47 +0100
committerGauvain Pocentek <gauvain@pocentek.net>2018-01-01 15:44:47 +0100
commitfa520242b878d25e37aacfcb0d838c58d3a4b271 (patch)
tree2d63086ba96dd02765359591beab77960bf3e844 /docs/gl_objects/groups.rst
parentf5850d950a77b1d985fdc3d1639e2627468d3548 (diff)
downloadgitlab-fa520242b878d25e37aacfcb0d838c58d3a4b271.tar.gz
Add support for project and group custom variables
implements parts of #367
Diffstat (limited to 'docs/gl_objects/groups.rst')
-rw-r--r--docs/gl_objects/groups.rst35
1 files changed, 35 insertions, 0 deletions
diff --git a/docs/gl_objects/groups.rst b/docs/gl_objects/groups.rst
index 9006ceb..9b5edb0 100644
--- a/docs/gl_objects/groups.rst
+++ b/docs/gl_objects/groups.rst
@@ -91,6 +91,41 @@ List the subgroups for a group::
subgroups = group.subgroups.list()
+Group custom attributes
+=======================
+
+Reference
+---------
+
+* v4 API:
+
+ + :class:`gitlab.v4.objects.GroupCustomAttribute`
+ + :class:`gitlab.v4.objects.GroupCustomAttributeManager`
+ + :attr:`gitlab.v4.objects.Group.customattributes`
+
+* GitLab API: https://docs.gitlab.com/ce/api/custom_attributes.html
+
+Examples
+--------
+
+List custom attributes for a group::
+
+ attrs = group.customattributes.list()
+
+Get a custom attribute for a group::
+
+ attr = group.customattributes.get(attr_key)
+
+Set (create or update) a custom attribute for a group::
+
+ attr = group.customattributes.set(attr_key, attr_value)
+
+Delete a custom attribute for a group::
+
+ attr.delete()
+ # or
+ group.customattributes.delete(attr_key)
+
Group members
=============