diff options
| author | Rémy Coutable <remy@rymai.me> | 2017-03-02 13:18:02 +0300 |
|---|---|---|
| committer | Rémy Coutable <remy@rymai.me> | 2017-03-02 13:18:02 +0300 |
| commit | 034c64968224caafaa3aec904359bf82cce36f7a (patch) | |
| tree | c71e679bc09d443e48e87cec80cd5740082aadd2 /doc | |
| parent | d4154195329b0a823848df8ceae144aebd6ccf6b (diff) | |
| parent | 61baf3528d2f39ffc8f7aa07eddf3df0cec3508b (diff) | |
Merge branch '28807-search-for-milestone-by-title-in-rest-api' into 'master'
Enable filtering milestones by search criteria in the API
Closes #28807
See merge request !9606
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/milestones.md | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/api/milestones.md b/doc/api/milestones.md index 63c5dc2c05d..9439db84e9b 100644 --- a/doc/api/milestones.md +++ b/doc/api/milestones.md @@ -10,6 +10,7 @@ GET /projects/:id/milestones?iid=42 GET /projects/:id/milestones?iid[]=42&iid[]=43 GET /projects/:id/milestones?state=active GET /projects/:id/milestones?state=closed +GET /projects/:id/milestones?search=version ``` Parameters: @@ -18,7 +19,8 @@ Parameters: | --------- | ---- | -------- | ----------- | | `id` | integer | yes | The ID of a project | | `iid` | Array[integer] | optional | Return only the milestone having the given `iid` | -| `state` | string | optional | Return only `active` or `closed` milestones` | +| `state` | string | optional | Return only `active` or `closed` milestones` | +| `search` | string | optional | Return only milestones with a title or description matching the provided string | ```bash curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/5/milestones @@ -115,4 +117,4 @@ GET /projects/:id/milestones/:milestone_id/merge_requests Parameters: - `id` (required) - The ID of a project -- `milestone_id` (required) - The ID of a project milestone
\ No newline at end of file +- `milestone_id` (required) - The ID of a project milestone |