Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
73e3a1cd
Commit
73e3a1cd
authored
Feb 20, 2019
by
Robert Schilling
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add API support for filtering confidential issues
parent
66c9a311
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
53 additions
and
0 deletions
+53
-0
doc/api/issues.md
doc/api/issues.md
+7
-0
lib/api/issues.rb
lib/api/issues.rb
+10
-0
spec/requests/api/issues_spec.rb
spec/requests/api/issues_spec.rb
+36
-0
No files found.
doc/api/issues.md
View file @
73e3a1cd
...
@@ -32,6 +32,7 @@ GET /issues?author_id=5
...
@@ -32,6 +32,7 @@ GET /issues?author_id=5
GET /issues?assignee_id=5
GET /issues?assignee_id=5
GET /issues?my_reaction_emoji=star
GET /issues?my_reaction_emoji=star
GET /issues?search=foo&in=title
GET /issues?search=foo&in=title
GET /issues?confidential=true
```
```
| Attribute | Type | Required | Description |
| Attribute | Type | Required | Description |
...
@@ -52,6 +53,7 @@ GET /issues?search=foo&in=title
...
@@ -52,6 +53,7 @@ GET /issues?search=foo&in=title
|
`created_before`
| datetime | no | Return issues created on or before the given time |
|
`created_before`
| datetime | no | Return issues created on or before the given time |
|
`updated_after`
| datetime | no | Return issues updated on or after the given time |
|
`updated_after`
| datetime | no | Return issues updated on or after the given time |
|
`updated_before`
| datetime | no | Return issues updated on or before the given time |
|
`updated_before`
| datetime | no | Return issues updated on or before the given time |
|
`confidential `
| Boolean | no | Filter confidential or public issues. |
```
bash
```
bash
curl
--header
"PRIVATE-TOKEN: <your_access_token>"
https://gitlab.example.com/api/v4/issues
curl
--header
"PRIVATE-TOKEN: <your_access_token>"
https://gitlab.example.com/api/v4/issues
...
@@ -148,6 +150,7 @@ GET /groups/:id/issues?search=issue+title+or+description
...
@@ -148,6 +150,7 @@ GET /groups/:id/issues?search=issue+title+or+description
GET /groups/:id/issues?author_id=5
GET /groups/:id/issues?author_id=5
GET /groups/:id/issues?assignee_id=5
GET /groups/:id/issues?assignee_id=5
GET /groups/:id/issues?my_reaction_emoji=star
GET /groups/:id/issues?my_reaction_emoji=star
GET /groups/:id/issues?confidential=true
```
```
| Attribute | Type | Required | Description |
| Attribute | Type | Required | Description |
...
@@ -168,6 +171,7 @@ GET /groups/:id/issues?my_reaction_emoji=star
...
@@ -168,6 +171,7 @@ GET /groups/:id/issues?my_reaction_emoji=star
|
`created_before`
| datetime | no | Return issues created on or before the given time |
|
`created_before`
| datetime | no | Return issues created on or before the given time |
|
`updated_after`
| datetime | no | Return issues updated on or after the given time |
|
`updated_after`
| datetime | no | Return issues updated on or after the given time |
|
`updated_before`
| datetime | no | Return issues updated on or before the given time |
|
`updated_before`
| datetime | no | Return issues updated on or before the given time |
|
`confidential `
| Boolean | no | Filter confidential or public issues. |
```
bash
```
bash
curl
--header
"PRIVATE-TOKEN: <your_access_token>"
https://gitlab.example.com/api/v4/groups/4/issues
curl
--header
"PRIVATE-TOKEN: <your_access_token>"
https://gitlab.example.com/api/v4/groups/4/issues
...
@@ -264,6 +268,7 @@ GET /projects/:id/issues?search=issue+title+or+description
...
@@ -264,6 +268,7 @@ GET /projects/:id/issues?search=issue+title+or+description
GET /projects/:id/issues?author_id=5
GET /projects/:id/issues?author_id=5
GET /projects/:id/issues?assignee_id=5
GET /projects/:id/issues?assignee_id=5
GET /projects/:id/issues?my_reaction_emoji=star
GET /projects/:id/issues?my_reaction_emoji=star
GET /projects/:id/issues?confidential=true
```
```
| Attribute | Type | Required | Description |
| Attribute | Type | Required | Description |
...
@@ -284,6 +289,8 @@ GET /projects/:id/issues?my_reaction_emoji=star
...
@@ -284,6 +289,8 @@ GET /projects/:id/issues?my_reaction_emoji=star
|
`created_before`
| datetime | no | Return issues created on or before the given time |
|
`created_before`
| datetime | no | Return issues created on or before the given time |
|
`updated_after`
| datetime | no | Return issues updated on or after the given time |
|
`updated_after`
| datetime | no | Return issues updated on or after the given time |
|
`updated_before`
| datetime | no | Return issues updated on or before the given time |
|
`updated_before`
| datetime | no | Return issues updated on or before the given time |
|
`confidential `
| Boolean | no | Filter confidential or public issues. |
```
bash
```
bash
curl
--header
"PRIVATE-TOKEN: <your_access_token>"
https://gitlab.example.com/api/v4/projects/4/issues
curl
--header
"PRIVATE-TOKEN: <your_access_token>"
https://gitlab.example.com/api/v4/projects/4/issues
...
...
lib/api/issues.rb
View file @
73e3a1cd
...
@@ -15,6 +15,14 @@ module API
...
@@ -15,6 +15,14 @@ module API
params
:issue_params_ee
do
params
:issue_params_ee
do
end
end
def
convert_confidential_param
(
args
)
confidential
=
args
.
delete
(
:confidential
)
return
args
if
confidential
.
nil?
args
[
:confidential
]
=
confidential
?
'yes'
:
'no'
args
end
end
end
helpers
do
helpers
do
...
@@ -26,6 +34,7 @@ module API
...
@@ -26,6 +34,7 @@ module API
args
[
:milestone_title
]
=
args
.
delete
(
:milestone
)
args
[
:milestone_title
]
=
args
.
delete
(
:milestone
)
args
[
:label_name
]
=
args
.
delete
(
:labels
)
args
[
:label_name
]
=
args
.
delete
(
:labels
)
args
[
:scope
]
=
args
[
:scope
].
underscore
if
args
[
:scope
]
args
[
:scope
]
=
args
[
:scope
].
underscore
if
args
[
:scope
]
args
=
convert_confidential_param
(
args
)
issues
=
IssuesFinder
.
new
(
current_user
,
args
).
execute
issues
=
IssuesFinder
.
new
(
current_user
,
args
).
execute
.
preload
(
:assignees
,
:labels
,
:notes
,
:timelogs
,
:project
,
:author
,
:closed_by
)
.
preload
(
:assignees
,
:labels
,
:notes
,
:timelogs
,
:project
,
:author
,
:closed_by
)
...
@@ -54,6 +63,7 @@ module API
...
@@ -54,6 +63,7 @@ module API
optional
:scope
,
type:
String
,
values:
%w[created-by-me assigned-to-me created_by_me assigned_to_me all]
,
optional
:scope
,
type:
String
,
values:
%w[created-by-me assigned-to-me created_by_me assigned_to_me all]
,
desc:
'Return issues for the given scope: `created_by_me`, `assigned_to_me` or `all`'
desc:
'Return issues 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'
optional
:my_reaction_emoji
,
type:
String
,
desc:
'Return issues reacted by the authenticated user by the given emoji'
optional
:confidential
,
type:
Boolean
,
desc:
'Filter confidential or public issues'
use
:pagination
use
:pagination
use
:issues_params_ee
use
:issues_params_ee
...
...
spec/requests/api/issues_spec.rb
View file @
73e3a1cd
...
@@ -183,6 +183,18 @@ describe API::Issues do
...
@@ -183,6 +183,18 @@ describe API::Issues do
expect_paginated_array_response
([
issue
.
id
,
confidential_issue
.
id
,
closed_issue
.
id
])
expect_paginated_array_response
([
issue
.
id
,
confidential_issue
.
id
,
closed_issue
.
id
])
end
end
it
'returns only confidential issues'
do
get
api
(
'/issues'
,
user
),
params:
{
confidential:
true
,
scope:
'all'
}
expect_paginated_array_response
(
confidential_issue
.
id
)
end
it
'returns only public issues'
do
get
api
(
'/issues'
,
user
),
params:
{
confidential:
false
}
expect_paginated_array_response
([
issue
.
id
,
closed_issue
.
id
])
end
it
'returns issues reacted by the authenticated user'
do
it
'returns issues reacted by the authenticated user'
do
issue2
=
create
(
:issue
,
project:
project
,
author:
user
,
assignees:
[
user
])
issue2
=
create
(
:issue
,
project:
project
,
author:
user
,
assignees:
[
user
])
create
(
:award_emoji
,
awardable:
issue2
,
user:
user2
,
name:
'star'
)
create
(
:award_emoji
,
awardable:
issue2
,
user:
user2
,
name:
'star'
)
...
@@ -557,6 +569,18 @@ describe API::Issues do
...
@@ -557,6 +569,18 @@ describe API::Issues do
expect_paginated_array_response
([
group_confidential_issue
.
id
,
group_issue
.
id
])
expect_paginated_array_response
([
group_confidential_issue
.
id
,
group_issue
.
id
])
end
end
it
'returns only confidential issues'
do
get
api
(
base_url
,
user
),
params:
{
confidential:
true
}
expect_paginated_array_response
(
group_confidential_issue
.
id
)
end
it
'returns only public issues'
do
get
api
(
base_url
,
user
),
params:
{
confidential:
false
}
expect_paginated_array_response
([
group_closed_issue
.
id
,
group_issue
.
id
])
end
it
'returns an array of labeled group issues'
do
it
'returns an array of labeled group issues'
do
get
api
(
base_url
,
user
),
params:
{
labels:
group_label
.
title
}
get
api
(
base_url
,
user
),
params:
{
labels:
group_label
.
title
}
...
@@ -782,6 +806,18 @@ describe API::Issues do
...
@@ -782,6 +806,18 @@ describe API::Issues do
expect_paginated_array_response
([
issue
.
id
,
confidential_issue
.
id
,
closed_issue
.
id
])
expect_paginated_array_response
([
issue
.
id
,
confidential_issue
.
id
,
closed_issue
.
id
])
end
end
it
'returns only confidential issues'
do
get
api
(
"
#{
base_url
}
/issues"
,
author
),
params:
{
confidential:
true
}
expect_paginated_array_response
(
confidential_issue
.
id
)
end
it
'returns only public issues'
do
get
api
(
"
#{
base_url
}
/issues"
,
author
),
params:
{
confidential:
false
}
expect_paginated_array_response
([
issue
.
id
,
closed_issue
.
id
])
end
it
'returns project confidential issues for assignee'
do
it
'returns project confidential issues for assignee'
do
get
api
(
"
#{
base_url
}
/issues"
,
assignee
)
get
api
(
"
#{
base_url
}
/issues"
,
assignee
)
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment