Merge branch 'feature/custom-attributes-on-projects-and-groups' into 'master'

Support custom attributes on groups and projects

See merge request gitlab-org/gitlab-ce!14593

3 files changed, 31 insertions, 8 deletions

diff --git a/doc/api/custom_attributes.md b/doc/api/custom_attributes.md
index 8b26f7093ab..91d1b0e1520 100644
--- a/doc/api/custom_attributes.md
+++ b/doc/api/custom_attributes.md
@@ -2,17 +2,22 @@
 
 Every API call to custom attributes must be authenticated as administrator.
 
+Custom attributes are currently available on users, groups, and projects,
+which will be referred to as "resource" in this documentation.
+
 ## List custom attributes
 
-Get all custom attributes on a user.
+Get all custom attributes on a resource.
 
 ```
 GET /users/:id/custom_attributes
+GET /groups/:id/custom_attributes
+GET /projects/:id/custom_attributes
 ```
 
 | Attribute | Type | Required | Description |
 | --------- | ---- | -------- | ----------- |
-| `id` | integer | yes | The ID of a user |
+| `id` | integer | yes | The ID of a resource |
 
 ```bash
 curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/users/42/custom_attributes
@@ -35,15 +40,17 @@ Example response:
 
 ## Single custom attribute
 
-Get a single custom attribute on a user.
+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
 ```
 
 | Attribute | Type | Required | Description |
 | --------- | ---- | -------- | ----------- |
-| `id` | integer | yes | The ID of a user |
+| `id` | integer | yes | The ID of a resource |
 | `key` | string | yes | The key of the custom attribute |
 
 ```bash
@@ -61,16 +68,18 @@ Example response:
 
 ## Set custom attribute
 
-Set a custom attribute on a user. The attribute will be updated if it already exists,
+Set a custom attribute on a resource. The attribute will be updated if it already exists,
 or newly created otherwise.
 
 ```
 PUT /users/:id/custom_attributes/:key
+PUT /groups/:id/custom_attributes/:key
+PUT /projects/:id/custom_attributes/:key
 ```
 
 | Attribute | Type | Required | Description |
 | --------- | ---- | -------- | ----------- |
-| `id` | integer | yes | The ID of a user |
+| `id` | integer | yes | The ID of a resource |
 | `key` | string | yes | The key of the custom attribute |
 | `value` | string | yes | The value of the custom attribute |
 
@@ -89,15 +98,17 @@ Example response:
 
 ## Delete custom attribute
 
-Delete a custom attribute on a user.
+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
 ```
 
 | Attribute | Type | Required | Description |
 | --------- | ---- | -------- | ----------- |
-| `id` | integer | yes | The ID of a user |
+| `id` | integer | yes | The ID of a resource |
 | `key` | string | yes | The key of the custom attribute |
 
 ```bash
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
diff --git a/doc/api/projects.md b/doc/api/projects.md
index 07331d05231..5a403f7593a 100644
--- a/doc/api/projects.md
+++ b/doc/api/projects.md
@@ -192,6 +192,12 @@ GET /projects
 ]
 ```
 
+You can filter by [custom attributes](custom_attributes.md) with:
+
+```
+GET /projects?custom_attributes[key]=value&custom_attributes[other_key]=other_value
+```
+
 ## List user projects
 
 Get a list of visible projects for the given user. When accessed without