Skip to content

Commit d4195a8

Browse files
[JIRA] add parameter validateQuery for search API (atlassian-api#752)
Allows users to set the parameter `validateQuery` for the Search API. This can be useful in situations where a request for issue key(s) contains a deleted issue, preventing: ``` {"errorMessages":["An issue with key 'DELETED-1' does not exist for field 'key'."],"errors":{}} ```
1 parent 2d145fe commit d4195a8

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

atlassian/jira.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2259,7 +2259,7 @@ def get_all_screen_fields(self, screen_id):
22592259
Reference: https://docs.atlassian.com/software/jira/docs/api/REST/8.5.0/#api/2/search
22602260
"""
22612261

2262-
def jql(self, jql, fields="*all", start=0, limit=None, expand=None):
2262+
def jql(self, jql, fields="*all", start=0, limit=None, expand=None, validate_query=None):
22632263
"""
22642264
Get issues from jql search result with all related fields
22652265
:param jql:
@@ -2268,6 +2268,7 @@ def jql(self, jql, fields="*all", start=0, limit=None, expand=None):
22682268
:param limit: OPTIONAL: The limit of the number of issues to return, this may be restricted by
22692269
fixed system limits. Default by built-in method: 50
22702270
:param expand: OPTIONAL: expand the search result
2271+
:param validate_query: Whether to validate the JQL query
22712272
:return:
22722273
"""
22732274
params = {}
@@ -2283,6 +2284,8 @@ def jql(self, jql, fields="*all", start=0, limit=None, expand=None):
22832284
params["jql"] = jql
22842285
if expand is not None:
22852286
params["expand"] = expand
2287+
if validate_query is not None:
2288+
params["validateQuery"] = validate_query
22862289
return self.get("rest/api/2/search", params=params)
22872290

22882291
def csv(self, jql, limit=1000, all_fields=True, start=None, delimiter=None):

0 commit comments

Comments
 (0)