diff options
| author | Sean McGivern <sean@mcgivern.me.uk> | 2017-04-26 11:20:47 +0000 |
|---|---|---|
| committer | Sean McGivern <sean@mcgivern.me.uk> | 2017-04-26 11:20:47 +0000 |
| commit | f00bb1c29ea438be66b3766545a57b468ade37d4 (patch) | |
| tree | 0b196290ecbb61bc2cab4ad4726e977fb2667aa5 /doc/api | |
| parent | 52bd4b88dc557f0b3c63e82d0f2093f22b28ae9d (diff) | |
| parent | 51207344f8f26358998bfe4d1e1dd057f11d09f4 (diff) | |
| download | gitlab-ce-f00bb1c29ea438be66b3766545a57b468ade37d4.tar.gz | |
Merge branch 'more-mr-filters' into 'master'
More merge request filters
Closes #26301
See merge request !10924
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/merge_requests.md | 16 |
1 files changed, 11 insertions, 5 deletions
diff --git a/doc/api/merge_requests.md b/doc/api/merge_requests.md index ff956add348..dde855b2bd4 100644 --- a/doc/api/merge_requests.md +++ b/doc/api/merge_requests.md @@ -11,15 +11,21 @@ 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 +GET /projects/:id/merge_requests?labels=bug,reproduced ``` 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 [ |