Commit 2b3e64a6 authored by Achilleas Pipinellis's avatar Achilleas Pipinellis

Clean up namespaces API documentation

[ci skip]
parent ddc8b91a
# Namespaces # 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. [Pagination](README.md#pagination) is used.
## List namespaces ## List namespaces
Get a list of namespaces. As a user, your namespaces are listed whereas if you Get a list of the namespaces of the authenticated user. If the user is an
are an administrator you get a list of all namespaces in the GitLab instance. administrator, a list of all namespaces in the GitLab instance is shown.
``` ```
GET /namespaces GET /namespaces
``` ```
Example request:
```bash ```bash
curl -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/namespaces curl -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/namespaces
``` ```
Example response:
```json ```json
[ [
{ {
...@@ -44,10 +51,14 @@ GET /namespaces?search=foobar ...@@ -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 | | `search` | string | no | Returns a list of namespaces the user is authorized to see based on the search criteria |
Example request:
```bash ```bash
curl -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/namespaces?search=twitter curl -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/namespaces?search=twitter
``` ```
Example response:
```json ```json
[ [
{ {
......
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