Skip to content

Migrate Jira integration from deprecated API v2 to v3 endpoints#117

Open
Claude wants to merge 2 commits intomainfrom
claude/update-jira-api-endpoints
Open

Migrate Jira integration from deprecated API v2 to v3 endpoints#117
Claude wants to merge 2 commits intomainfrom
claude/update-jira-api-endpoints

Conversation

@Claude
Copy link

@Claude Claude AI commented Feb 6, 2026

Atlassian removed Jira API v2 endpoints (/rest/api/2/search, /rest/api/2/field, /rest/api/2/serverInfo) effective May 2025. The integration was failing with "The requested API has been removed. Please migrate to the /rest/api/3/search/jql API."

Changes

  • Configure Python jira library to use API v3 by passing options={"api_version": 3} to the JIRA client constructor in jiralib.py

This ensures all API calls automatically use the v3 endpoints:

  • /rest/api/2/search/rest/api/3/search/jql
  • /rest/api/2/field/rest/api/3/field
  • /rest/api/2/serverInfo/rest/api/3/serverInfo
# jiralib.py:53
self.j = JIRA(url, basic_auth=(user, token), options={"api_version": 3})
Original prompt

This section details on the original issue you should resolve

<issue_title>Integration nonfunctional - must use new Jira API endpoints</issue_title>
<issue_description>Integration failed with message:

"text: The requested API has been removed. Please migrate to the /rest/api/3/search/jql API. A full migration guideline is available at https://developer.atlassian.com/changelog/#CHANGE-2046"

Note the endpoints for which requests to Jira failed are:
/rest/api/2/search
/rest/api/2/field
/rest/api/2/serverInfo

The search function is being replaced by:
/rest/api/3/search/jql</issue_description>

<agent_instructions>We need to switch off of deprecated endpoints mentioned in the PR description. </agent_instructions>

Comments on the Issue (you are @claude[agent] in this section)

@zkoppert I'm not aware of anyone actively maintaining this repo. It is likely one that should be archived. @zkoppert Are either of you interested in reviewing an API update to this integration? @AndreiRosu @jacksonblalock

I could take a try at converting it over to the new endpoints but I don't have a test setup. I'd prefer not to leave you all hanging if this is something that is really needed.</comment_new>

Co-authored-by: zkoppert <6935431+zkoppert@users.noreply.github.com>
@Claude Claude AI changed the title [WIP] Update integration to use new Jira API endpoints Migrate Jira integration from deprecated API v2 to v3 endpoints Feb 6, 2026
@Claude Claude AI requested a review from zkoppert February 6, 2026 23:53
Copy link

@jmeridth jmeridth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@zkoppert zkoppert marked this pull request as ready for review February 7, 2026 03:24
Copilot AI review requested due to automatic review settings February 7, 2026 03:24
@zkoppert
Copy link
Member

zkoppert commented Feb 7, 2026

Cc/ @jacksonblalock

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the Jira client initialization to target Jira REST API v3 endpoints, addressing failures caused by removed v2 endpoints in newer Jira environments.

Changes:

  • Configure the python-jira JIRA client with options={"api_version": 3}.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

self.user = user
self.token = token
self.j = JIRA(url, basic_auth=(user, token))
self.j = JIRA(url, basic_auth=(user, token), options={"api_version": 3})
Copy link

Copilot AI Feb 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This hard-codes Jira REST API v3 for all deployments. The repo documentation and CLI/action inputs currently describe targeting a “Jira Server instance”; Jira Server/Data Center may not expose the v3 REST API, so this change could break those users. Consider making the REST API version configurable (e.g., input/env var with a default aligned to documented support) or implementing a simple fallback/auto-detect, and update the docs accordingly.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Integration nonfunctional - must use new Jira API endpoints

3 participants