Commit ddc8b91a authored by Achilleas Pipinellis's avatar Achilleas Pipinellis

Refactor namespaces API documentation [ci skip]

parent 835f1961
# Namespaces # Namespaces
Namespaces account for usernames and groupnames.
[Pagination](README.md#pagination) is used.
## List namespaces ## List namespaces
Get a list of namespaces. (As user: my namespaces, as admin: all 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 /namespaces GET /namespaces
``` ```
```bash
curl -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/namespaces
```
```json ```json
[ [
{ {
...@@ -23,22 +32,28 @@ GET /namespaces ...@@ -23,22 +32,28 @@ GET /namespaces
] ]
``` ```
You can search for namespaces by name or path, see below.
## Search for namespace ## Search for namespace
Get all namespaces that match your string in their name or path. Get all namespaces that match a string in their name or path.
``` ```
GET /namespaces?search=foobar GET /namespaces?search=foobar
``` ```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `search` | string | no | Returns a list of namespaces the user is authorized to see based on the search criteria |
```bash
curl -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/namespaces?search=twitter
```
```json ```json
[ [
{ {
"id": 1, "id": 4,
"path": "user1", "path": "twitter",
"kind": "user" "kind": "group"
} }
] ]
``` ```
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