summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMarkus Koller <markus-koller@gmx.ch>2017-09-18 17:07:38 +0200
committerMarkus Koller <markus.koller.ext@siemens.com>2017-11-06 10:51:50 +0100
commit1f773a8ef5a1f76166d0455c6a5e473278885c17 (patch)
treeed2d955865b49aa5d102ccb4b4f64868d4d12b77 /doc
parent6902848a9c54f9eb1bfd82fe173ad0d5d62fe2d5 (diff)
downloadgitlab-ce-1f773a8ef5a1f76166d0455c6a5e473278885c17.tar.gz
Support custom attributes on groups
Diffstat (limited to 'doc')
-rw-r--r--doc/api/custom_attributes.md9
-rw-r--r--doc/api/groups.md6
2 files changed, 13 insertions, 2 deletions
diff --git a/doc/api/custom_attributes.md b/doc/api/custom_attributes.md
index 705f1d401cf..91d1b0e1520 100644
--- a/doc/api/custom_attributes.md
+++ b/doc/api/custom_attributes.md
@@ -1,8 +1,9 @@
# Custom Attributes API
Every API call to custom attributes must be authenticated as administrator.
-Custom attributes are currently available on users and projects, which will
-be referred to as "resource" in this documentation.
+
+Custom attributes are currently available on users, groups, and projects,
+which will be referred to as "resource" in this documentation.
## List custom attributes
@@ -10,6 +11,7 @@ Get all custom attributes on a resource.
```
GET /users/:id/custom_attributes
+GET /groups/:id/custom_attributes
GET /projects/:id/custom_attributes
```
@@ -42,6 +44,7 @@ Get a single custom attribute on a resource.
```
GET /users/:id/custom_attributes/:key
+GET /groups/:id/custom_attributes/:key
GET /projects/:id/custom_attributes/:key
```
@@ -70,6 +73,7 @@ or newly created otherwise.
```
PUT /users/:id/custom_attributes/:key
+PUT /groups/:id/custom_attributes/:key
PUT /projects/:id/custom_attributes/:key
```
@@ -98,6 +102,7 @@ Delete a custom attribute on a resource.
```
DELETE /users/:id/custom_attributes/:key
+DELETE /groups/:id/custom_attributes/:key
DELETE /projects/:id/custom_attributes/:key
```
diff --git a/doc/api/groups.md b/doc/api/groups.md
index 99d200c9c93..16db9c2f259 100644
--- a/doc/api/groups.md
+++ b/doc/api/groups.md
@@ -74,6 +74,12 @@ GET /groups?statistics=true
You can search for groups by name or path, see below.
+You can filter by [custom attributes](custom_attributes.md) with:
+
+```
+GET /groups?custom_attributes[key]=value&custom_attributes[other_key]=other_value
+```
+
## List a group's projects
Get a list of projects in this group. When accessed without authentication, only