diff options
| author | Frank Pavageau <frank.pavageau@gmail.com> | 2017-08-03 09:35:41 +0300 |
|---|---|---|
| committer | Frank Pavageau <fpavageau@ekino.com> | 2017-08-07 23:43:41 +0300 |
| commit | e3393dbec85477e743bf49d727ba71e3a70beb34 (patch) | |
| tree | 41806c90dcaa8916627257c1e7bca7511d5a079b /doc/api/milestones.md | |
| parent | 5f30350c5b2482f72e221cce33ebd66919fcd6b4 (diff) | |
Fix the iids parameters in the API documentation
Since the parameter name is really `iids[]`, it should be used consistently
across the documentation.
Diffstat (limited to 'doc/api/milestones.md')
| -rw-r--r-- | doc/api/milestones.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/api/milestones.md b/doc/api/milestones.md index a082d548499..84930f0bdc9 100644 --- a/doc/api/milestones.md +++ b/doc/api/milestones.md @@ -6,7 +6,7 @@ Returns a list of project milestones. ``` GET /projects/:id/milestones -GET /projects/:id/milestones?iids=42 +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 @@ -18,7 +18,7 @@ Parameters: | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | -| `iids` | Array[integer] | optional | Return only the milestones having the given `iids` | +| `iids[]` | Array[integer] | optional | Return only the milestones having the given `iid` | | `state` | string | optional | Return only `active` or `closed` milestones` | | `search` | string | optional | Return only milestones with a title or description matching the provided string | |