Commit 1ce3115b authored by Mike Jang's avatar Mike Jang

Merge branch...

Merge branch '213797-deprecate-projects-and-shared_projects-from-groups-api-responses-doc-changes' into 'master'

Document planned deprecation of 'projects' and 'shared_projects' attributes in Groups API in GitLab 13.0

See merge request gitlab-org/gitlab!29113
parents 1233228f e8004da0
......@@ -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
......
---
title: Document planned deprecation of 'projects' and 'shared_projects' attributes
in Groups API in GitLab 13.0
merge_request: 29113
author:
type: deprecated
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment