From ddc8b91a5f89c1bd1b4bed955231ae286420d9d2 Mon Sep 17 00:00:00 2001 From: Achilleas Pipinellis Date: Mon, 18 Jan 2016 09:42:44 +0100 Subject: Refactor namespaces API documentation [ci skip] --- doc/api/namespaces.md | 29 ++++++++++++++++++++++------- 1 file changed, 22 insertions(+), 7 deletions(-) (limited to 'doc/api/namespaces.md') diff --git a/doc/api/namespaces.md b/doc/api/namespaces.md index 7b3238441f6..68ed8bd3152 100644 --- a/doc/api/namespaces.md +++ b/doc/api/namespaces.md @@ -1,13 +1,22 @@ # Namespaces +Namespaces account for usernames and groupnames. + +[Pagination](README.md#pagination) is used. + ## 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 ``` +```bash +curl -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/namespaces +``` + ```json [ { @@ -23,22 +32,28 @@ GET /namespaces ] ``` -You can search for namespaces by name or path, see below. - ## 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 ``` +| 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 [ { - "id": 1, - "path": "user1", - "kind": "user" + "id": 4, + "path": "twitter", + "kind": "group" } ] ``` -- cgit v1.2.1 From 2b3e64a6015bcb9a2bf365dcab148d5024833d91 Mon Sep 17 00:00:00 2001 From: Achilleas Pipinellis Date: Sun, 24 Jan 2016 19:28:24 +0100 Subject: Clean up namespaces API documentation [ci skip] --- doc/api/namespaces.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) (limited to 'doc/api/namespaces.md') 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 [ { -- cgit v1.2.1