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

Merge branch 'feature/api-documentation-fixes' of github.com:Xylakant/gitlabhq into fixes/api

Browse source 
Conflicts:
	doc/api/projects.md
This commit is contained in:
Sebastian Ziebell 2013-02-27 16:49:45 +01:00
commit 43d7596030
2 changed files with 35 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

9
doc/api/README.md
View file

@ -1,6 +1,6 @@
# GitLab API
All API requests require authentication. You need to pass a `private_token` parameter by url or header. You can find or reset your private token in your profile.
All API requests require authentication. You need to pass a `private_token` parameter by url or header. If passed as header, the header name must be "PRIVATE-TOKEN" (capital and with dash instead of underscore). You can find or reset your private token in your profile.
If no, or an invalid, `private_token` is provided then an error message will be returned with status code 401:
@ -18,6 +18,13 @@ Example of a valid API request:
GET http://example.com/api/v3/projects?private_token=QVy1PB7sTxfy4pqfZM1U
```
Example for a valid API request using curl and authentication via header:
```
curl --header "PRIVATE-TOKEN: QVy1PB7sTxfy4pqfZM1U" "http://example.com/api/v3/projects"
```
The API uses JSON to serialize data. You don't need to specify `.json` at the end of API URL.
#### Pagination