Upcoming Deprecation of Jira Cloud Search APIs

[glewandowski]

What feature do you want to see added?

On October 31, 2024, Atlassian announced the deprecation of four Jira Cloud search APIs. These APIs will be replaced with new, more efficient alternatives through our enhanced JQL service, which are currently available for use. You can read more about these new APIs here.
Effective May 1, 2025, Atlassian will remove the following Jira REST endpoints:

• GET /rest/api/3/search
• POST /rest/api/3/search
• POST /rest/api/3/search/id
• POST /rest/api/3/expression/eval
  We have identified that this library may be used to access the deprecated endpoints in Jira Cloud. Failing to migrate to the new APIs before May 1, 2025, could negatively impact any solutions that depend on this library. By evolving our JQL service, we aim to provide a more reliable, performant, and scalable Jira experience tailored to meet the needs of enterprise customers.
  If you have any questions or require further assistance, please do not hesitate to ask on our developer community forum

Upstream changes

No response

[saurabhraghuvanshii]

can I work on this

[SohamJuneja]

I’ve implemented the changes as suggested, specifically:

Searched for instances of GET /rest/api/3/search, POST /rest/api/3/search, POST /rest/api/3/search/id, and POST /rest/api/3/expression/eval in the codebase.
Checked through relevant parts of the repository to locate any calls or references to these endpoints.
However, I wasn't able to find any instance of these API calls or related code in the repository.

[glewandowski]

I can see the deprecated APIs are used here

jira-plugin/src/main/java/hudson/plugins/jira/JiraRestService.java

Line 227 in 03411e0

public List<Issue> getIssuesFromJqlSearch(String jqlSearch, Integer maxResults) throws TimeoutException {

But I also I see, they use old, non-mantained Jira REST client. I'll check if Atlassian can release new version that doesn't use deprecated APis.

[skumar36-atlassian]

Hello Everyone

We're pleased to announce the release of Jira-Rest-Java-Client to 6.0.2 . This release includes new APIs for Jira Cloud, designed to replace the deprecated searchJql method. These enhanced APIs offer improved flexibility and control for your search operations.

New APIs Overview:

1. Basic Enhanced Search:
   enhancedSearchJql(String jql): Execute simple JQL queries and retrieve matching issues.
2. Advanced Search Options:
   enhancedSearchJql(String jql, Integer maxResults, String nextPageToken, Set fields, Set reconcileIssues): Customize your search with parameters like pagination, field selection, and issue reconciliation.
3. Issue Count Estimation:
   totalCount(String jql): Get an estimated count of issues matching your JQL.

FYI @SohamJuneja @glewandowski

[rantoniuk]

@SohamJuneja if you are still able to work on this, feel free to assign the issue to yourself and create a Pull Request when ready. You can pull the dependency updates from dependabot's PR in order to have jira-rest-java-client-core already updated to the 6.0.2 version mentioned above.