Jira Cloud: adjustment of jql search

Author: gonchik

atlassian/VERSION

@@ -1 +1 @@
-4.0.5
+4.0.6

atlassian/jira.py

@@ -3559,7 +3559,10 @@ def jql(
             params["expand"] = expand
         if validate_query is not None:
             params["validateQuery"] = validate_query
-        url = self.resource_url("search")
+        if self.cloud:
+            url = self.resource_url("search")
+        else:
+            url = self.resource_url("search/jql")
         return self.get(url, params=params)
 
     def enhanced_jql(
@@ -3619,6 +3622,39 @@ def approximate_issue_count(
         url = self.resource_url("search/approximate-count")
         return self.post(url, data)
 
+    def match_jql(self, issue_ids: List[int], jqls: List[str]) -> Optional[dict[Any, Any]]:
+        """
+        Checks which issues match a list of JQL queries.
+
+        This method corresponds to the /rest/api/3/jql/match endpoint.
+        It helps you verify if a set of issues would be returned by given JQL queries.
+
+        :param issue_ids: A list of issue IDs to be checked against the JQLs.
+        :param jqls: A list of JQL query strings to match.
+        :return: A dictionary containing the matching results from the API.
+                 For example:
+                 {
+                     "errors": [],
+                     "results": [
+                         {
+                             "matchedIssues": [10001],
+                             "errors": [],
+                             "jql": "project = FOO"
+                         },
+                         {
+                             "matchedIssues": ,
+                             "errors": [],
+                             "jql": "issuetype = Bug"
+                         }
+                     ]
+                 }
+        """
+        if not self.cloud:
+            raise ValueError("``approximate_issue_count`` method is only available for Jira Cloud platform")
+        payload = {"issueIds": issue_ids, "jqls": jqls}
+        url = self.resource_url("jql/match")
+        return self.post(url, data=payload)
+
     def jql_get_list_of_tickets(
         self,
         jql: str,
@@ -3665,7 +3701,10 @@ def jql_get_list_of_tickets(
             params["expand"] = expand
         if validate_query is not None:
             params["validateQuery"] = validate_query
-        url = self.resource_url("search")
+        if self.cloud:
+            url = self.resource_url("search")
+        else:
+            url = self.resource_url("search/jql")
 
         results: List[object] = []
         while True:

docs/jira.rst

@@ -10,6 +10,10 @@ Get issues from jql search result with all related fields
     issues = jira.jql(jql_request)
     print(issues)
 
+    # Check issues against JQL
+    # Checks whether one or more issues would be returned by one or more JQL queries.
+    jira.match_jql(issue_ids, jqls)
+
 Reindex Jira
 ------------