summaryrefslogtreecommitdiff
path: root/doc/api
diff options
context:
space:
mode:
authorDmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com>2015-05-03 14:34:23 +0300
committerDmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com>2015-05-03 14:34:23 +0300
commit747232eeda7c79ea65a5c208399a6c72872ff4bc (patch)
treed6677286d072a0651547d18a8fe317686ed907ee /doc/api
parenta7ddff87481138e43609bd12acbb76da2ec8dd7a (diff)
parent2c544d43c832e816614a9bef35e1899f34b4a53d (diff)
downloadgitlab-ce-747232eeda7c79ea65a5c208399a6c72872ff4bc.tar.gz
Merge branch 'api-iid' of https://github.com/jubianchi/gitlabhq into jubianchi-api-iid
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/issues.md2
-rw-r--r--doc/api/merge_requests.md4
-rw-r--r--doc/api/milestones.md2
3 files changed, 7 insertions, 1 deletions
diff --git a/doc/api/issues.md b/doc/api/issues.md
index a7dd8b74c35..d407bc35d79 100644
--- a/doc/api/issues.md
+++ b/doc/api/issues.md
@@ -99,11 +99,13 @@ GET /projects/:id/issues?labels=foo,bar
GET /projects/:id/issues?labels=foo,bar&state=opened
GET /projects/:id/issues?milestone=1.0.0
GET /projects/:id/issues?milestone=1.0.0&state=opened
+GET /projects/:id/issues?iid=42
```
Parameters:
- `id` (required) - The ID of a project
+- `iid` (optional) - Return the issue having the given `iid`
- `state` (optional) - Return `all` issues or just those that are `opened` or `closed`
- `labels` (optional) - Comma-separated list of label names
- `milestone` (optional) - Milestone title
diff --git a/doc/api/merge_requests.md b/doc/api/merge_requests.md
index 6a272539e45..c1d82ad9576 100644
--- a/doc/api/merge_requests.md
+++ b/doc/api/merge_requests.md
@@ -10,11 +10,13 @@ The pagination parameters `page` and `per_page` can be used to restrict the list
GET /projects/:id/merge_requests
GET /projects/:id/merge_requests?state=opened
GET /projects/:id/merge_requests?state=all
+GET /projects/:id/merge_requests?iid=42
```
Parameters:
- `id` (required) - The ID of a project
+- `iid` (optional) - Return the request having the given `iid`
- `state` (optional) - Return `all` requests or just those that are `merged`, `opened` or `closed`
- `order_by` (optional) - Return requests ordered by `created_at` or `updated_at` fields. Default is `created_at`
- `sort` (optional) - Return requests sorted in `asc` or `desc` order. Default is `desc`
@@ -388,6 +390,6 @@ Parameters:
]
```
-## Comments on issues
+## Comments on merge requets
Comments are done via the notes resource.
diff --git a/doc/api/milestones.md b/doc/api/milestones.md
index d48b3bcce8a..a6828728264 100644
--- a/doc/api/milestones.md
+++ b/doc/api/milestones.md
@@ -6,6 +6,7 @@ Returns a list of project milestones.
```
GET /projects/:id/milestones
+GET /projects/:id/milestones?iid=42
```
```json
@@ -27,6 +28,7 @@ GET /projects/:id/milestones
Parameters:
- `id` (required) - The ID of a project
+- `iid` (optional) - Return the milestone having the given `iid`
## Get single milestone