diff options
| author | Stuart Pook <s.pook@criteo.com> | 2014-04-04 18:32:53 +0200 |
|---|---|---|
| committer | Stuart Pook <s.pook@criteo.com> | 2014-04-07 16:18:25 +0200 |
| commit | 66209fbc7668b5b64b34c2997185223891211829 (patch) | |
| tree | 1d9597aed58c1770bee973c92c90fe8aca56aa8a /doc | |
| parent | 650d0bc695eb0f874561b8d4ed3fc86510573fba (diff) | |
| download | gitlab-ce-66209fbc7668b5b64b34c2997185223891211829.tar.gz | |
Add optional parameter to list merge requests
Add an optional parameter to list merge requests to restrict the
returned merge requests to those that are "opened", "merged" or
"closed". By default all merge requests are returned. Note that
"all" can be given to explicitly request all merge requests.
Diffstat (limited to 'doc')
| -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 [ |