summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDouwe Maan <douwe@gitlab.com>2017-06-29 13:04:13 +0000
committerDouwe Maan <douwe@gitlab.com>2017-06-29 13:04:13 +0000
commit46def2045ec8ca560a7ba04cef3feac42c52e6cb (patch)
tree372da4d4a9a4ed0022a08fb3e4d716867be3ff8d /doc
parent572fa2cb0263b87b5323ebb0d72bc71fa252df78 (diff)
parente8ebad15e3d6f5ddbe3596a6616aafec95725261 (diff)
downloadgitlab-ce-46def2045ec8ca560a7ba04cef3feac42c52e6cb.tar.gz
Merge branch 'add-members-count-and-parent-id-data-on-namespaces-api' into 'master'
Add group members counting related data on namespaces API See merge request !12497
Diffstat (limited to 'doc')
-rw-r--r--doc/api/namespaces.md14
1 files changed, 12 insertions, 2 deletions
diff --git a/doc/api/namespaces.md b/doc/api/namespaces.md
index 4ad6071a0ed..8133251dffe 100644
--- a/doc/api/namespaces.md
+++ b/doc/api/namespaces.md
@@ -29,22 +29,30 @@ Example response:
{
"id": 1,
"path": "user1",
- "kind": "user"
+ "kind": "user",
+ "full_path": "user1"
},
{
"id": 2,
"path": "group1",
- "kind": "group"
+ "kind": "group",
+ "full_path": "group1",
+ "parent_id": "null",
+ "members_count_with_descendants": 2
},
{
"id": 3,
"path": "bar",
"kind": "group",
"full_path": "foo/bar",
+ "parent_id": "9",
+ "members_count_with_descendants": 5
}
]
```
+**Note**: `members_count_with_descendants` are presented only for group masters/owners.
+
## Search for namespace
Get all namespaces that match a string in their name or path.
@@ -72,6 +80,8 @@ Example response:
"path": "twitter",
"kind": "group",
"full_path": "twitter",
+ "parent_id": "null",
+ "members_count_with_descendants": 2
}
]
```