diff options
| author | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-01-24 19:28:24 +0100 |
|---|---|---|
| committer | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-01-24 19:28:24 +0100 |
| commit | 2b3e64a6015bcb9a2bf365dcab148d5024833d91 (patch) | |
| tree | cecc69ad899ce4b825c2bf9c67fbc75849983dc7 /doc | |
| parent | ddc8b91a5f89c1bd1b4bed955231ae286420d9d2 (diff) | |
| download | gitlab-ce-2b3e64a6015bcb9a2bf365dcab148d5024833d91.tar.gz | |
Clean up namespaces API documentationdoc_refactor_namespaces_api
[ci skip]
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/namespaces.md | 17 |
1 files changed, 14 insertions, 3 deletions
diff --git a/doc/api/namespaces.md b/doc/api/namespaces.md index 68ed8bd3152..42d9ce3d391 100644 --- a/doc/api/namespaces.md +++ b/doc/api/namespaces.md @@ -1,22 +1,29 @@ # Namespaces -Namespaces account for usernames and groupnames. +Usernames and groupnames fall under a special category called namespaces. + +For users and groups supported API calls see the [users](users.md) and +[groups](groups.md) documentation respectively. [Pagination](README.md#pagination) is used. ## List namespaces -Get a list of namespaces. As a user, your namespaces are listed whereas if you -are an administrator you get a list of all namespaces in the GitLab instance. +Get a list of the namespaces of the authenticated user. If the user is an +administrator, a list of all namespaces in the GitLab instance is shown. ``` GET /namespaces ``` +Example request: + ```bash curl -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/namespaces ``` +Example response: + ```json [ { @@ -44,10 +51,14 @@ GET /namespaces?search=foobar | --------- | ---- | -------- | ----------- | | `search` | string | no | Returns a list of namespaces the user is authorized to see based on the search criteria | +Example request: + ```bash curl -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/namespaces?search=twitter ``` +Example response: + ```json [ { |