summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJacopo <beschi.jacopo@gmail.com>2018-09-28 12:45:43 +0200
committerJacopo <beschi.jacopo@gmail.com>2018-09-28 12:55:17 +0200
commit73bdca2e03f559d8603fcd828f82fa4893fdcfa1 (patch)
treec885aaf9cd2027c738f695ec03332a7a7f56268d
parentba66e0cc9cc26df686ed47d926a3edcde497baa1 (diff)
downloadgitlab-ce-73bdca2e03f559d8603fcd828f82fa4893fdcfa1.tar.gz
Docs for Project/Groups members API with inherited members51404-update-groups-and-projects-api-docs
Expains the differences between `api/projects/:id/members` and `api/projects/:id/members/all` related to inherited members.
-rw-r--r--changelogs/unreleased/51404-update-groups-and-projects-api-docs.yml5
-rw-r--r--doc/api/members.md2
2 files changed, 7 insertions, 0 deletions
diff --git a/changelogs/unreleased/51404-update-groups-and-projects-api-docs.yml b/changelogs/unreleased/51404-update-groups-and-projects-api-docs.yml
new file mode 100644
index 00000000000..da02a91041b
--- /dev/null
+++ b/changelogs/unreleased/51404-update-groups-and-projects-api-docs.yml
@@ -0,0 +1,5 @@
+---
+title: Docs for Project/Groups members API with inherited members
+merge_request: 21984
+author: Jacopo Beschi @jacopo-beschi
+type: added
diff --git a/doc/api/members.md b/doc/api/members.md
index 7b228b92594..bb4fae35f52 100644
--- a/doc/api/members.md
+++ b/doc/api/members.md
@@ -15,6 +15,7 @@ The access levels are defined in the `Gitlab::Access` module. Currently, these l
## List all members of a group or project
Gets a list of group or project members viewable by the authenticated user.
+Returns only direct members and not inherited members through ancestors groups.
```
GET /groups/:id/members
@@ -61,6 +62,7 @@ Example response:
## List all members of a group or project including inherited members
Gets a list of group or project members viewable by the authenticated user, including inherited members through ancestor groups.
+Returns multiple times the same user (with different member attributes) when the user is a member of the project/group and of one or more ancestor group.
```
GET /groups/:id/members/all