diff options
| author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-04-10 06:09:41 +0000 |
|---|---|---|
| committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-04-10 06:09:41 +0000 |
| commit | 187ee320b39af22929d74c5a2d9b0650bf50a09b (patch) | |
| tree | ff04eab6c7914f6408c4f637f863fc07aa409cdc /doc/api | |
| parent | a7dc052b7e01aee680d130274c79da9bfa459272 (diff) | |
| download | gitlab-ce-187ee320b39af22929d74c5a2d9b0650bf50a09b.tar.gz | |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/groups.md | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/doc/api/groups.md b/doc/api/groups.md index 33a3c2305d5..1809ddfa47f 100644 --- a/doc/api/groups.md +++ b/doc/api/groups.md @@ -240,6 +240,10 @@ Example response: ] ``` +NOTE: **Note:** + +To distinguish between a project in the group and a project shared to the group, the `namespace` attribute can be used. When a project has been shared to the group, its `namespace` will be different from the group the request is being made for. + ## Details of a group Get all details of a group. This endpoint can be accessed without authentication @@ -255,7 +259,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`). | +| `with_projects` | boolean | no | Include details from projects that belong to the specified group (defaults to `true`). (Deprecated, [will be removed in 13.0](https://gitlab.com/gitlab-org/gitlab/-/issues/213797). To get the details of all projects within a group, use the [list a group's projects endpoint](#list-a-groups-projects).) | ```shell curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/4 @@ -578,6 +582,10 @@ This endpoint returns: and later. To get the details of all projects within a group, use the [list a group's projects endpoint](#list-a-groups-projects) instead. +NOTE: **Note:** + +The `projects` and `shared_projects` attributes [will be deprecated in GitLab 13.0](https://gitlab.com/gitlab-org/gitlab/-/issues/213797). To get the details of all projects within a group, use the [list a group's projects endpoint](#list-a-groups-projects) instead. + Example response: ```json |