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

update contents of API README

Browse source
This commit is contained in:
Nihad Abbasov 2012-12-01 02:07:57 -08:00
parent 42ef89c98a
commit b17e94c37b
1 changed files with 2 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
doc/api/README.md
View file

@ -25,7 +25,7 @@ The API uses JSON to serialize data. You don't need to specify `.json` at the en
When listing resources you can pass the following parameters: When listing resources you can pass the following parameters:
+ `page` (default: `1`) - page number + `page` (default: `1`) - page number
+ `per_page` (default: `20`, max: `100`) - how many items to list per page + `per_page` (default: `20`, max: `100`) - number of items to list per page
## Contents ## Contents
@ -36,3 +36,4 @@ When listing resources you can pass the following parameters:
+ [Repositories](https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/repositories.md) + [Repositories](https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/repositories.md)
+ [Issues](https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/issues.md) + [Issues](https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/issues.md)
+ [Milestones](https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/milestones.md) + [Milestones](https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/milestones.md)
+ [Notes](https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/notes.md)