diff options
| author | Robert Schilling <rschilling@student.tugraz.at> | 2017-04-25 16:56:32 +0200 |
|---|---|---|
| committer | Robert Schilling <rschilling@student.tugraz.at> | 2017-04-25 22:07:38 +0200 |
| commit | 2ea5d4b7af57037f10f42fddf96bb8c96875a8cb (patch) | |
| tree | 6e25537ad545063d15f00afc5df93c351e1f39b2 /doc | |
| parent | 04811cbbff15c7b40d679a81f0c920216f873824 (diff) | |
| download | gitlab-ce-2ea5d4b7af57037f10f42fddf96bb8c96875a8cb.tar.gz | |
Ability to filter merge requests by labels and milestones
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/merge_requests.md | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/doc/api/merge_requests.md b/doc/api/merge_requests.md index ff956add348..23bf7234572 100644 --- a/doc/api/merge_requests.md +++ b/doc/api/merge_requests.md @@ -11,15 +11,20 @@ GET /projects/:id/merge_requests GET /projects/:id/merge_requests?state=opened GET /projects/:id/merge_requests?state=all GET /projects/:id/merge_requests?iids[]=42&iids[]=43 +GET /projects/:id/merge_requests?milestone=release ``` Parameters: -- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user -- `iid` (optional) - Return the request having the given `iid` -- `state` (optional) - Return `all` requests or just those that are `merged`, `opened` or `closed` -- `order_by` (optional) - Return requests ordered by `created_at` or `updated_at` fields. Default is `created_at` -- `sort` (optional) - Return requests sorted in `asc` or `desc` order. Default is `desc` +| Attribute | Type | Required | Description | +| --------- | ---- | -------- | ----------- | +| `id` | integer | yes | The ID of a project | +| `iids` | Array[integer] | no | Return the request having the given `iid` | +| `state` | string | no | Return all merge requests or just those that are `opened`, `closed`, or `merged`| +| `order_by`| string | no | Return requests ordered by `created_at` or `updated_at` fields. Default is `created_at` | +| `sort` | string | no | Return requests sorted in `asc` or `desc` order. Default is `desc` | +| `milestone` | string | no | Return merge requests for a specific milestone | +| `labels` | string | no | Return merge requests matching a comma separated list of labels | ```json [ |