diff options
| author | Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com> | 2014-04-13 20:10:39 +0300 |
|---|---|---|
| committer | Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com> | 2014-04-13 20:10:39 +0300 |
| commit | 53b52b11d5cbaa32f98c267eb53b4b7c928a92c4 (patch) | |
| tree | 49cfa37aad6bbf696da7c80fd966718a7b302da6 /doc/api/merge_requests.md | |
| parent | 481bbd753416d14dbfbfe342856792bd51e0090f (diff) | |
| parent | 66209fbc7668b5b64b34c2997185223891211829 (diff) | |
| download | gitlab-ce-53b52b11d5cbaa32f98c267eb53b4b7c928a92c4.tar.gz | |
Merge pull request #6699 from criteo/api_get_open_merge_requests
Add optional parameter to list merge requests
Diffstat (limited to 'doc/api/merge_requests.md')
| -rw-r--r-- | doc/api/merge_requests.md | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/doc/api/merge_requests.md b/doc/api/merge_requests.md index 483c4188713..4e864ae1078 100644 --- a/doc/api/merge_requests.md +++ b/doc/api/merge_requests.md @@ -1,15 +1,21 @@ ## List merge requests -Get all merge requests for this project. This function takes pagination parameters -`page` and `per_page` to restrict the list of merge requests. +Get all merge requests for this project. +The `state` parameter can be used to get only merge requests with a +given state (`opened`, `closed`, or `merged`) or all of them (`all`). +The pagination parameters `page` and `per_page` can be used to restrict the +list of merge requests. ``` GET /projects/:id/merge_requests +GET /projects/:id/merge_requests?state=opened +GET /projects/:id/merge_requests?state=all ``` Parameters: + `id` (required) - The ID of a project ++ `state` (optional) - Return `all` requests or just those that are `merged`, `opened` or `closed` ```json [ |