Fix JQL reserved keyword query

Ben Kingrequested to merge
benjaminking-jira-reserved-key-fix into master

What does this MR do and why?

Summary

Related to: #426176 (closed)

This change fixes a bug where Jira project keys that contain reserved JQL (Jira Query Language) words would cause the Jira issue list to fail to load in GitLab. The fix works by wrapping each Jira project key in double quotes when building search queries, which prevents Jira from misinterpreting project keys as special keywords. The outdated documentation warning about this limitation has also been removed, since the bug is now resolved.

References

Screenshots or screen recordings

Following the setup instructions below, navigating to project → Plan → Jira issues will now show applicable keyed issues:

Before After
image.png image.png
image.png image.png

How to set up and validate locally

  1. Create a group > project structure. Ensure the group or instance has Ultimate subscription access for feature testing the vulnerabilities.
  2. In the project, go to Settings > Integrations. Select Jira issues.
  3. Using an Atlassian Cloud account, ensure you have pre-created a "space" that uses the key INT (which is a reserved keyword in JQL).
  4. Create at least one bug/issue in the Atlassian space to have something to populate. This will likely end up being INT-1 as an issue.
  5. Provide your Atlassian username (email) and an API key.
  6. For Jira issues and Jira issues for vulnerabilities, enable these features and set the Jira project key/keys values to INT (as shown below).
  7. Validate your permissions with Test settings, then Save changes.

image.png

Jira Issues

  1. Go to Plan → Jira issues. On this development branch, it should be able to load all relevant issues that exist in the Atlassian project.

Jira issues for vulnerabilities

  1. Go to Secure → Vulnerability report. Select Submit vulnerability.
  2. Fill out all required fields with dummy data. For vulnerability identifiers, you can use this unrelated CVE:
    1. Identifier code: CVE-2026-20079
    2. Identifier URL: https://www.cve.org/CVERecord?id=CVE-2026-20079
  3. Once created. it will try to search for and load linked vulnerability issues in Jira.
  4. None should exist at this point, but select Create Jira issue.
  5. Subsequent page loads will load the related Jira issue that was created.

MR acceptance checklist

Evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.

Edited by Ben King

Merge request reports