Add author_id & assignee_id param to /issues API
Allow issues filtering on `author_id` and `assignee_id`.
This commit is contained in:
Toon Claes
parent
ea6dfcad9f
commit
8bf89cb4ab
5 changed files with 49 additions and 1 deletions
|
|
@ -11,6 +11,7 @@
|
|||
# group_id: integer
|
||||
# project_id: integer
|
||||
# milestone_title: string
|
||||
# author_id: integer
|
||||
# assignee_id: integer
|
||||
# search: string
|
||||
# label_name: string
|
||||
|
|
|
|||
4
changelogs/unreleased/tc-issue-api-assignee.yml
Normal file
4
changelogs/unreleased/tc-issue-api-assignee.yml
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
---
|
||||
title: Add author_id & assignee_id param to /issues API
|
||||
merge_request: 13004
|
||||
author:
|
||||
|
|
@ -26,7 +26,8 @@ GET /issues?labels=foo,bar&state=opened
|
|||
GET /issues?milestone=1.0.0
|
||||
GET /issues?milestone=1.0.0&state=opened
|
||||
GET /issues?iids[]=42&iids[]=43
|
||||
GET /issues?search=issue+title+or+description
|
||||
GET /issues?author_id=5
|
||||
GET /issues?assignee_id=5
|
||||
```
|
||||
|
||||
| Attribute | Type | Required | Description |
|
||||
|
|
@ -34,6 +35,8 @@ GET /issues?search=issue+title+or+description
|
|||
| `state` | string | no | Return all issues or just those that are `opened` or `closed` |
|
||||
| `labels` | string | no | Comma-separated list of label names, issues must have all labels to be returned. `No+Label` lists all issues with no labels |
|
||||
| `milestone` | string | no | The milestone title |
|
||||
| `author_id` | integer | no | Returns issues created by the given user `id` (not limited to issues created by the authenticated user) |
|
||||
| `assignee_id` | integer | no | Returns issues assigned to the given user `id` (not limited to issues created by the authenticated user) |
|
||||
| `iids` | Array[integer] | no | Return only the issues having the given `iid` |
|
||||
| `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` |
|
||||
|
|
@ -117,6 +120,8 @@ GET /groups/:id/issues?milestone=1.0.0
|
|||
GET /groups/:id/issues?milestone=1.0.0&state=opened
|
||||
GET /groups/:id/issues?iids[]=42&iids[]=43
|
||||
GET /groups/:id/issues?search=issue+title+or+description
|
||||
GET /groups/:id/issues?author_id=5
|
||||
GET /groups/:id/issues?assignee_id=5
|
||||
```
|
||||
|
||||
| Attribute | Type | Required | Description |
|
||||
|
|
@ -126,6 +131,8 @@ GET /groups/:id/issues?search=issue+title+or+description
|
|||
| `labels` | string | no | Comma-separated list of label names, issues must have all labels to be returned. `No+Label` lists all issues with no labels |
|
||||
| `iids` | Array[integer] | no | Return only the issues having the given `iid` |
|
||||
| `milestone` | string | no | The milestone title |
|
||||
| `author_id` | integer | no | Returns issues created by the given user `id` (not limited to issues created by the authenticated user) |
|
||||
| `assignee_id` | integer | no | Returns issues assigned to the given user `id` (not limited to issues created by the authenticated user) |
|
||||
| `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` |
|
||||
| `search` | string | no | Search group issues against their `title` and `description` |
|
||||
|
|
@ -209,6 +216,8 @@ GET /projects/:id/issues?milestone=1.0.0
|
|||
GET /projects/:id/issues?milestone=1.0.0&state=opened
|
||||
GET /projects/:id/issues?iids[]=42&iids[]=43
|
||||
GET /projects/:id/issues?search=issue+title+or+description
|
||||
GET /projects/:id/issues?author_id=5
|
||||
GET /projects/:id/issues?assignee_id=5
|
||||
```
|
||||
|
||||
| Attribute | Type | Required | Description |
|
||||
|
|
@ -218,6 +227,8 @@ GET /projects/:id/issues?search=issue+title+or+description
|
|||
| `state` | string | no | Return all issues or just those that are `opened` or `closed` |
|
||||
| `labels` | string | no | Comma-separated list of label names, issues must have all labels to be returned. `No+Label` lists all issues with no labels |
|
||||
| `milestone` | string | no | The milestone title |
|
||||
| `author_id` | integer | no | Returns issues created by the given user `id` (not limited to issues created by the authenticated user) |
|
||||
| `assignee_id` | integer | no | Returns issues assigned to the given user `id` (not limited to issues created by the authenticated user) |
|
||||
| `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` |
|
||||
| `search` | string | no | Search project issues against their `title` and `description` |
|
||||
|
|
|
|||
|
|
@ -8,6 +8,9 @@ module API
|
|||
def find_issues(args = {})
|
||||
args = params.merge(args)
|
||||
|
||||
# Do not scope to "authored" when author or assignee id is given
|
||||
args.delete(:scope) if args[:author_id] || args[:assignee_id]
|
||||
|
||||
args.delete(:id)
|
||||
args[:milestone_title] = args.delete(:milestone)
|
||||
args[:label_name] = args.delete(:labels)
|
||||
|
|
@ -29,6 +32,8 @@ module API
|
|||
optional :search, type: String, desc: 'Search issues for text present in the title or description'
|
||||
optional :created_after, type: DateTime, desc: 'Return issues created after the specified time'
|
||||
optional :created_before, type: DateTime, desc: 'Return issues created before the specified time'
|
||||
optional :author_id, type: Integer, desc: 'Return issues which are authored by the user with the given ID'
|
||||
optional :assignee_id, type: Integer, desc: 'Return issues which are assigned to the user with the given ID'
|
||||
use :pagination
|
||||
end
|
||||
|
||||
|
|
|
|||
|
|
@ -105,6 +105,33 @@ describe API::Issues do
|
|||
expect(json_response.second['id']).to eq(closed_issue.id)
|
||||
end
|
||||
|
||||
it 'returns issues authored by the given author id' do
|
||||
issue2 = create(:issue, author: user2, project: project)
|
||||
|
||||
get api('/issues', user), author_id: user2.id
|
||||
|
||||
expect_paginated_array_response(size: 1)
|
||||
expect(first_issue['id']).to eq(issue2.id)
|
||||
end
|
||||
|
||||
it 'returns issues assigned to the given assignee id' do
|
||||
issue2 = create(:issue, assignees: [user2], project: project)
|
||||
|
||||
get api('/issues', user), assignee_id: user2.id
|
||||
|
||||
expect_paginated_array_response(size: 1)
|
||||
expect(first_issue['id']).to eq(issue2.id)
|
||||
end
|
||||
|
||||
it 'returns issues authored by the given author id and assigned to the given assignee id' do
|
||||
issue2 = create(:issue, author: user2, assignees: [user2], project: project)
|
||||
|
||||
get api('/issues', user), author_id: user2.id, assignee_id: user2.id
|
||||
|
||||
expect_paginated_array_response(size: 1)
|
||||
expect(first_issue['id']).to eq(issue2.id)
|
||||
end
|
||||
|
||||
it 'returns issues matching given search string for title' do
|
||||
get api("/issues", user), search: issue.title
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue