diff options
| author | Douwe Maan <douwe@gitlab.com> | 2018-02-14 10:40:59 +0000 |
|---|---|---|
| committer | Douwe Maan <douwe@gitlab.com> | 2018-02-14 10:40:59 +0000 |
| commit | 6085656bffa54cdbe21e776e283f87ece313991f (patch) | |
| tree | 0798db9f44217da4ff340ab66844673e5e189839 /doc/api/groups.md | |
| parent | 5e829934f95bcae25f5c09583b6febe6e2e646b6 (diff) | |
| parent | b7cd99c376c2f953f30a4bf982b69780e3d6985b (diff) | |
| download | gitlab-ce-6085656bffa54cdbe21e776e283f87ece313991f.tar.gz | |
Merge branch 'feature/include-custom-attributes-in-api' into 'master'
Allow including custom attributes in API responses
See merge request gitlab-org/gitlab-ce!16526
Diffstat (limited to 'doc/api/groups.md')
| -rw-r--r-- | doc/api/groups.md | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/api/groups.md b/doc/api/groups.md index de730cdd869..f50558b58a6 100644 --- a/doc/api/groups.md +++ b/doc/api/groups.md @@ -15,6 +15,7 @@ Parameters: | `order_by` | string | no | Order groups by `name` or `path`. Default is `name` | | `sort` | string | no | Order groups in `asc` or `desc` order. Default is `asc` | | `statistics` | boolean | no | Include group statistics (admins only) | +| `with_custom_attributes` | boolean | no | Include [custom attributes](custom_attributes.md) in response (admins only) | | `owned` | boolean | no | Limit to groups owned by the current user | ``` @@ -98,6 +99,7 @@ Parameters: | `order_by` | string | no | Order groups by `name` or `path`. Default is `name` | | `sort` | string | no | Order groups in `asc` or `desc` order. Default is `asc` | | `statistics` | boolean | no | Include group statistics (admins only) | +| `with_custom_attributes` | boolean | no | Include [custom attributes](custom_attributes.md) in response (admins only) | | `owned` | boolean | no | Limit to groups owned by the current user | ``` @@ -145,6 +147,7 @@ Parameters: | `simple` | boolean | no | Return only the ID, URL, name, and path of each project | | `owned` | boolean | no | Limit by projects owned by the current user | | `starred` | boolean | no | Limit by projects starred by the current user | +| `with_custom_attributes` | boolean | no | Include [custom attributes](custom_attributes.md) in response (admins only) | Example response: @@ -204,6 +207,7 @@ Parameters: | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user | +| `with_custom_attributes` | boolean | no | Include [custom attributes](custom_attributes.md) in response (admins only) | ```bash curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/groups/4 |