diff options
author | Tiago Botelho <tiagonbotelho@hotmail.com> | 2018-07-09 13:24:29 +0100 |
---|---|---|
committer | Tiago Botelho <tiagonbotelho@hotmail.com> | 2018-07-09 16:28:17 +0100 |
commit | e6f3452314c73875bbf9560a84706161c25c2831 (patch) | |
tree | d949113ed99dd0ef46a2fbf887fb5d07c0405d93 /doc/api/groups.md | |
parent | 21a511e47e448250802b1777b43589c9168e0638 (diff) | |
download | gitlab-ce-e6f3452314c73875bbf9560a84706161c25c2831.tar.gz |
Adds with_projects optional parameter to /groups/:id API endpoint
Diffstat (limited to 'doc/api/groups.md')
-rw-r--r-- | doc/api/groups.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/doc/api/groups.md b/doc/api/groups.md index 53d72509423..11de75039ee 100644 --- a/doc/api/groups.md +++ b/doc/api/groups.md @@ -210,6 +210,7 @@ Parameters: | --------- | ---- | -------- | ----------- | | `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) | +| `with_projects` | boolean | no | Include details from projects that belong to the specified group (defaults to `true`). | ```bash curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/groups/4 @@ -361,6 +362,30 @@ Example response: } ``` +When adding the parameter `with_projects=false`, projects will not be returned. + +```bash +curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/groups/4?with_projects=false +``` + +Example response: + +```json +{ + "id": 4, + "name": "Twitter", + "path": "twitter", + "description": "Aliquid qui quis dignissimos distinctio ut commodi voluptas est.", + "visibility": "public", + "avatar_url": null, + "web_url": "https://gitlab.example.com/groups/twitter", + "request_access_enabled": false, + "full_name": "Twitter", + "full_path": "twitter", + "parent_id": null +} +``` + ## New group Creates a new project group. Available only for users who can create groups. |