diff options
author | Dmitriy Zaporozhets <dzaporozhets@sphereconsultinginc.com> | 2012-09-21 14:22:30 +0400 |
---|---|---|
committer | Dmitriy Zaporozhets <dzaporozhets@sphereconsultinginc.com> | 2012-09-21 14:22:30 +0400 |
commit | 10d3a30b255cd85b2cf7af39814fd7418eecd838 (patch) | |
tree | 1082a03374c7130ad33f9136d0d41f979bfe603c /doc/api/commits.md | |
parent | 4cc169d3cacea7e4325bb5632cc8878a7c3f41fe (diff) |
APi for commits. Better api docs
Diffstat (limited to 'doc/api/commits.md')
-rw-r--r-- | doc/api/commits.md | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/doc/api/commits.md b/doc/api/commits.md new file mode 100644 index 00000000000..fccb35c3300 --- /dev/null +++ b/doc/api/commits.md @@ -0,0 +1,38 @@ +## List Commits + +Get a list of project commits. + +``` +GET /projects/:id/commits +``` + +Parameters: + ++ `id` (required) - The ID or code name of a project ++ `ref_name` (optional) - branch/tag name ++ `page` (optional) ++ `per_page` (optional) + + +```json + +[ + { + "id": "ed899a2f4b50b4370feeea94676502b42383c746", + "short_id": "ed899a2f4b5", + "title": "Replace sanitize with escape once", + "author_name": "Dmitriy Zaporozhets", + "author_email": "dzaporozhets@sphereconsultinginc.com", + "created_at": "2012-09-20T11:50:22+03:00" + }, + { + "id": "6104942438c14ec7bd21c6cd5bd995272b3faff6", + "short_id": "6104942438c", + "title": "Sanitize for network graph", + "author_name": "randx", + "author_email": "dmitriy.zaporozhets@gmail.com", + "created_at": "2012-09-20T09:06:12+03:00" + } +] + +``` |