deac/gitlabhq
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

add docs for existing API

Browse source
This commit is contained in:
Nihad Abbasov 2012-07-05 06:57:45 -07:00
parent 5f38f67247
commit f086676b7c
3 changed files with 389 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

90
doc/api/users.md Normal file
View file

@ -0,0 +1,90 @@
## List users
Get a list of users.
```
GET /users
```
```json
[
{
"id": 1,
"email": "john@example.com",
"name": "John Smith",
"blocked": false,
"created_at": "2012-05-23T08:00:58Z",
"bio": null,
"skype": "",
"linkedin": "",
"twitter": "",
"dark_scheme": false,
"theme_id": 1
},
{
"id": 2,
"email": "jack@example.com",
"name": "Jack Smith",
"blocked": false,
"created_at": "2012-05-23T08:01:01Z",
"bio": null,
"skype": "",
"linkedin": "",
"twitter": "",
"dark_scheme": true,
"theme_id": 1
}
]
```
## Single user
Get a single user.
```
GET /users/:id
```
Parameters:
+ `id` (required) - The ID of a user
```json
{
"id": 1,
"email": "john@example.com",
"name": "John Smith",
"blocked": false,
"created_at": "2012-05-23T08:00:58Z",
"bio": null,
"skype": "",
"linkedin": "",
"twitter": "",
"dark_scheme": false,
"theme_id": 1
}
```
## Current user
Get currently authenticated user.
```
GET /user
```
```json
{
"id": 1,
"email": "john@example.com",
"name": "John Smith",
"blocked": false,
"created_at": "2012-05-23T08:00:58Z",
"bio": null,
"skype": "",
"linkedin": "",
"twitter": "",
"dark_scheme": false,
"theme_id": 1
}
```