Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2021-03-06 03:09:02 +0300
committerGitLab Bot <gitlab-bot@gitlab.com>2021-03-06 03:09:02 +0300
commit0313282761321e443e6342af3e897dd240d4141c (patch)
tree0c3b0cfeb4f58844d27d2043c497aa8d82847cf3 /doc/api/projects.md
parent250c4c259654a5d971a7daac846239c70954215b (diff)
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api/projects.md')
-rw-r--r--doc/api/projects.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/doc/api/projects.md b/doc/api/projects.md
index 4e65e416613..4e2002ed889 100644
--- a/doc/api/projects.md
+++ b/doc/api/projects.md
@@ -1040,6 +1040,43 @@ GET /projects/:id/users
]
```
+## List a project's groups
+
+Get a list of ancestor groups for this project.
+
+```plaintext
+GET /projects/:id/groups
+```
+
+| Attribute | Type | Required | Description |
+|-----------------------------|-------------------|------------------------|-------------|
+| `id` | integer/string | **{check-circle}** Yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding). |
+| `search` | string | **{dotted-circle}** No | Search for specific groups. |
+| `skip_groups` | array of integers | **{dotted-circle}** No | Skip the group IDs passed. |
+| `with_shared` | boolean | **{dotted-circle}** No | Include projects shared with this group. Default is `false`. |
+| `shared_min_access_level` | integer | **{dotted-circle}** No | Limit to shared groups with at least this [access level](members.md#valid-access-levels). |
+
+```json
+[
+ {
+ "id": 1,
+ "name": "Foobar Group",
+ "avatar_url": "http://localhost:3000/uploads/group/avatar/1/foo.jpg",
+ "web_url": "http://localhost:3000/groups/foo-bar",
+ "full_name": "Foobar Group",
+ "full_path": "foo-bar",
+ },
+ {
+ "id": 2,
+ "name": "Shared Group",
+ "avatar_url": "http://gitlab.example.com/uploads/group/avatar/1/bar.jpg",
+ "web_url": "http://gitlab.example.com/groups/foo/bar",
+ "full_name": "Shared Group",
+ "full_path": "foo/shared",
+ }
+]
+```
+
## Get project events
Refer to the [Events API documentation](events.md#list-a-projects-visible-events).