summaryrefslogtreecommitdiff
path: root/doc/api/milestones.md
diff options
context:
space:
mode:
authorJarka Kadlecova <jarka@gitlab.com>2017-02-09 15:28:19 +0100
committerJarka Kadlecova <jarka@gitlab.com>2017-03-02 13:17:39 +0100
commit17ee1e1a63520f88663697608920e816aa7128c4 (patch)
tree84e0d25fc2988cbaf669cf5f501786411487ccc2 /doc/api/milestones.md
parent6efa5dc04a2e3c64664676e30962760ebf99b72a (diff)
downloadgitlab-ce-17ee1e1a63520f88663697608920e816aa7128c4.tar.gz
Use iids as filter parameter
Diffstat (limited to 'doc/api/milestones.md')
-rw-r--r--doc/api/milestones.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/api/milestones.md b/doc/api/milestones.md
index 9439db84e9b..3c86357a6c3 100644
--- a/doc/api/milestones.md
+++ b/doc/api/milestones.md
@@ -6,8 +6,8 @@ Returns a list of project milestones.
```
GET /projects/:id/milestones
-GET /projects/:id/milestones?iid=42
-GET /projects/:id/milestones?iid[]=42&iid[]=43
+GET /projects/:id/milestones?iids=42
+GET /projects/:id/milestones?iids[]=42&iids[]=43
GET /projects/:id/milestones?state=active
GET /projects/:id/milestones?state=closed
GET /projects/:id/milestones?search=version
@@ -18,7 +18,7 @@ Parameters:
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer | yes | The ID of a project |
-| `iid` | Array[integer] | optional | Return only the milestone having the given `iid` |
+| `iids` | Array[integer] | optional | Return only the milestones having the given `iids` |
| `state` | string | optional | Return only `active` or `closed` milestones` |
| `search` | string | optional | Return only milestones with a title or description matching the provided string |