Add my_reaction_emoji param to /merge_requests API
This commit is contained in:
parent
cf9c54bd31
commit
7e42711659
|
@ -16,6 +16,7 @@
|
||||||
# label_name: string
|
# label_name: string
|
||||||
# sort: string
|
# sort: string
|
||||||
# non_archived: boolean
|
# non_archived: boolean
|
||||||
|
# my_reaction_emoji: string
|
||||||
#
|
#
|
||||||
class MergeRequestsFinder < IssuableFinder
|
class MergeRequestsFinder < IssuableFinder
|
||||||
def klass
|
def klass
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
---
|
---
|
||||||
title: Add my_reaction_emoji param to /issues API
|
title: Add my_reaction_emoji param to /issues and /merge_requests API
|
||||||
merge_request: 14016
|
merge_request: 14016
|
||||||
author: Hiroyuki Sato
|
author: Hiroyuki Sato
|
||||||
type: added
|
type: added
|
||||||
|
|
|
@ -22,24 +22,26 @@ GET /merge_requests?state=all
|
||||||
GET /merge_requests?milestone=release
|
GET /merge_requests?milestone=release
|
||||||
GET /merge_requests?labels=bug,reproduced
|
GET /merge_requests?labels=bug,reproduced
|
||||||
GET /merge_requests?author_id=5
|
GET /merge_requests?author_id=5
|
||||||
|
GET /merge_requests?my_reaction_emoji=star
|
||||||
GET /merge_requests?scope=assigned-to-me
|
GET /merge_requests?scope=assigned-to-me
|
||||||
```
|
```
|
||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
| Attribute | Type | Required | Description |
|
| Attribute | Type | Required | Description |
|
||||||
| --------- | ---- | -------- | ----------- |
|
| ------------------- | -------- | -------- | ---------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `state` | string | no | Return all merge requests or just those that are `opened`, `closed`, or `merged`|
|
| `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` |
|
| `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` |
|
| `sort` | string | no | Return requests sorted in `asc` or `desc` order. Default is `desc` |
|
||||||
| `milestone` | string | no | Return merge requests for a specific milestone |
|
| `milestone` | string | no | Return merge requests for a specific milestone |
|
||||||
| `view` | string | no | If `simple`, returns the `iid`, URL, title, description, and basic state of merge request |
|
| `view` | string | no | If `simple`, returns the `iid`, URL, title, description, and basic state of merge request |
|
||||||
| `labels` | string | no | Return merge requests matching a comma separated list of labels |
|
| `labels` | string | no | Return merge requests matching a comma separated list of labels |
|
||||||
| `created_after` | datetime | no | Return merge requests created after the given time (inclusive) |
|
| `created_after` | datetime | no | Return merge requests created after the given time (inclusive) |
|
||||||
| `created_before` | datetime | no | Return merge requests created before the given time (inclusive) |
|
| `created_before` | datetime | no | Return merge requests created before the given time (inclusive) |
|
||||||
| `scope` | string | no | Return merge requests for the given scope: `created-by-me`, `assigned-to-me` or `all`. Defaults to `created-by-me` |
|
| `scope` | string | no | Return merge requests for the given scope: `created-by-me`, `assigned-to-me` or `all`. Defaults to `created-by-me` |
|
||||||
| `author_id` | integer | no | Returns merge requests created by the given user `id`. Combine with `scope=all` or `scope=assigned-to-me` |
|
| `author_id` | integer | no | Returns merge requests created by the given user `id`. Combine with `scope=all` or `scope=assigned-to-me` |
|
||||||
| `assignee_id` | integer | no | Returns merge requests assigned to the given user `id` |
|
| `assignee_id` | integer | no | Returns merge requests assigned to the given user `id` |
|
||||||
|
| `my_reaction_emoji` | string | no | Return merge requests reacted by the authenticated user by the given emoji ` _([Introduced][ce-14016] in GitLab 10.0)_ |
|
||||||
|
|
||||||
```json
|
```json
|
||||||
[
|
[
|
||||||
|
@ -116,6 +118,7 @@ GET /projects/:id/merge_requests?state=all
|
||||||
GET /projects/:id/merge_requests?iids[]=42&iids[]=43
|
GET /projects/:id/merge_requests?iids[]=42&iids[]=43
|
||||||
GET /projects/:id/merge_requests?milestone=release
|
GET /projects/:id/merge_requests?milestone=release
|
||||||
GET /projects/:id/merge_requests?labels=bug,reproduced
|
GET /projects/:id/merge_requests?labels=bug,reproduced
|
||||||
|
GET /projects/:id/merge_requests?my_reaction_emoji=star
|
||||||
```
|
```
|
||||||
|
|
||||||
Parameters:
|
Parameters:
|
||||||
|
@ -135,6 +138,7 @@ Parameters:
|
||||||
| `scope` | string | no | Return merge requests for the given scope: `created-by-me`, `assigned-to-me` or `all` _([Introduced][ce-13060] in GitLab 9.5)_ |
|
| `scope` | string | no | Return merge requests for the given scope: `created-by-me`, `assigned-to-me` or `all` _([Introduced][ce-13060] in GitLab 9.5)_ |
|
||||||
| `author_id` | integer | no | Returns merge requests created by the given user `id` _([Introduced][ce-13060] in GitLab 9.5)_ |
|
| `author_id` | integer | no | Returns merge requests created by the given user `id` _([Introduced][ce-13060] in GitLab 9.5)_ |
|
||||||
| `assignee_id` | integer | no | Returns merge requests assigned to the given user `id` _([Introduced][ce-13060] in GitLab 9.5)_ |
|
| `assignee_id` | integer | no | Returns merge requests assigned to the given user `id` _([Introduced][ce-13060] in GitLab 9.5)_ |
|
||||||
|
| `my_reaction_emoji` | string | no | Return merge requests reacted by the authenticated user by the given emoji ` _([Introduced][ce-14016] in GitLab 10.0)_ |
|
||||||
|
|
||||||
```json
|
```json
|
||||||
[
|
[
|
||||||
|
|
|
@ -40,6 +40,7 @@ module API
|
||||||
optional :assignee_id, type: Integer, desc: 'Return merge requests which are assigned to the user with the given ID'
|
optional :assignee_id, type: Integer, desc: 'Return merge requests which are assigned to the user with the given ID'
|
||||||
optional :scope, type: String, values: %w[created-by-me assigned-to-me all],
|
optional :scope, type: String, values: %w[created-by-me assigned-to-me all],
|
||||||
desc: 'Return merge requests for the given scope: `created-by-me`, `assigned-to-me` or `all`'
|
desc: 'Return merge requests for the given scope: `created-by-me`, `assigned-to-me` or `all`'
|
||||||
|
optional :my_reaction_emoji, type: String, desc: 'Return issues reacted by the authenticated user by the given emoji'
|
||||||
use :pagination
|
use :pagination
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
|
@ -117,6 +117,18 @@ describe API::MergeRequests do
|
||||||
expect(json_response.length).to eq(1)
|
expect(json_response.length).to eq(1)
|
||||||
expect(json_response.first['id']).to eq(merge_request3.id)
|
expect(json_response.first['id']).to eq(merge_request3.id)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
it 'returns merge requests reacted by the authenticated user by the given emoji' do
|
||||||
|
merge_request3 = create(:merge_request, :simple, author: user, assignee: user, source_project: project2, target_project: project2, source_branch: 'other-branch')
|
||||||
|
award_emoji = create(:award_emoji, awardable: merge_request3, user: user2, name: 'star')
|
||||||
|
|
||||||
|
get api('/merge_requests', user2), my_reaction_emoji: award_emoji.name, scope: 'all'
|
||||||
|
|
||||||
|
expect(response).to have_gitlab_http_status(200)
|
||||||
|
expect(json_response).to be_an Array
|
||||||
|
expect(json_response.length).to eq(1)
|
||||||
|
expect(json_response.first['id']).to eq(merge_request3.id)
|
||||||
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue