Adapt Jira Integration to new search endpoints

[holger-waschke]

this resolves #4513

[k0ste]

From what JIRA version this endpoints available? I'm interested because it might break compat Alertmanager with non super-recent JIRA versions

[jkroepke]

The new endpoint seems not part of the v2 API and is not available for Jira On Premise.

We want to preserve Jira On Premise compatibility, so I guess this is not enough.

[holger-waschke]

The new endpoint seems not part of the v2 API and is not available for Jira On Premise.

No, it´s part of v2 too, see here.
https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-search/#api-rest-api-2-search-jql-get

API v2 and v3 are technically identical, the only difference is the support of the ADF format, see source here.

We want to preserve Jira On Premise compatibility, so I guess this is not enough.

Well, as the documentation says

Note: This integration is only tested against a Jira Cloud instance. Jira Data Center (on premise instance) can work, but it's not guaranteed.

Source here

This doesn´t sound for me that it´s top priority to keep the combability. Imho it shouldn´t be priority as on-premise Jira Server is EOL anyway, see here.

[jkroepke]

API v2 and v3 are technically identical

OK. Cloud API v2 and v3 are technically identical (expect for issue body, where v3 requires ADF).

But I can't find the Rest Endpoint in the Jira Server Rest API.

https://docs.atlassian.com/software/jira/docs/api/REST/8.20.1/

Server is EOL anyway

Jira Data Center is not EOL.

[k0ste]

This doesn´t sound for me that it´s top priority to keep the combability. Imho it shouldn´t be priority as on-premise Jira Server is EOL anyway, see here.

If you make a patch for software that will break current deployments, it is a regression. Let me give you an example: the integration of AlertManager and JIRA works in a company where version v8.8.1 is deployed. There are no plans to update the version, as well as to retire JIRA. That is, most likely, this version will work for decades without changes. In this case, it seems much more convenient to add the field to the AM integration YAML, that will indicate which version of the API should be used. Or to select the version programmatically (some capabilities endpoint)

Otherwise, we will have to roll back this patch during AM build, since the integration is already completed and the human is only solving the problem, the JIRAlert does everything else. Thanks

[jkroepke]

In this case, it seems much more convenient to add the field to the AM integration YAML, that will indicate which version of the API should be used.

Would you say v2 is Jira Data Center, v3 is Jira Cloud? Not easy. Keep in mind, the Create Issue Rest API between v2 and v3 is not equal. While V2 API supports plain text with Jira Markup, in API v3 you must use ADF to create an issue. It might be result into a mix of using API Versions.

[holger-waschke]

In this case, it seems much more convenient to add the field to the AM integration YAML, that will indicate which version of the API should be used.

Would you say v2 is Jira Data Center, v3 is Jira Cloud? Not easy. Keep in mind, the Create Issue Rest API between v2 and v3 is not equal. While V2 API supports plain text with Jira Markup, in API v3 you must use ADF to create an issue. It might be result into a mix of using API Versions.

Yes, the endpoints are deprecated in both API versions, so this wouldn´t help.

Let´s get some things sorted:
Jira is doing rolling updates on their cloud instances and enforcing the new endpoints. So without a change soon this integration will not work anymore on the platform it was initially designed for.

While you can run software versions for decades without updating you have no assurance that 3rd party tools which are using this API will not implement breaking changes.

I can only follow official API documentation from ATL and the new Endpoint is available in V2 and V3 API Version. It´s not available in the REST API Documentation you posted, but there´s a big deprecation warning there.
Support for Server products ended Feb. 15, 2024. Learn what this means for you.

So IMHO we should really focus on the official supported API Versions, not the deprecated ones.

[k0ste]

While you can run software versions for decades without updating you have no assurance that 3rd party tools which are using this API will not implement breaking changes.

I can only follow official API documentation from ATL and the new Endpoint is available in V2 and V3 API Version. It´s not available in the REST API Documentation you posted, but there´s a big deprecation warning there. Support for Server products ended Feb. 15, 2024. Learn what this means for you.

So IMHO we should really focus on the official supported API Versions, not the deprecated ones.

I don't see that you added deprecation notes to this PR. About new version of Alertmanager is impossible to use on-prem, or you will be tagged several times a month when users try to integrate AM with on-prem JIRA

[jkroepke]

So IMHO we should really focus on the official supported API Versions, not the deprecated ones.

I agree! Jira Data Center is officially supported by Atlassian, so we have to cover it as well.

https://docs.atlassian.com/software/jira/docs/api/REST/9.14.0/ - thats Jira Data center 9.14 supported until 15 February 2026. Jira 11 will be supported until 13 August 2027 as well.

See https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html

@k0ste Whats your On Prem Version? I can only see Jira Software V8, but maybe your version is newer.

[jkroepke]

I wrote an proposal to solve this issue: #4513 (comment)

[k0ste]

@k0ste Whats your On Prem Version? I can only see Jira Software V8, but maybe your version is newer.

Version: 8.8.1
Build Number: 808001
Build Revision: e5cdcf9fa57df21d4b441572dda42ac58b826e01

[lerminou]

Hi, any news here ? jira cloud now blocks the old endpoint, the integration is KO

conf:
api_url: https://company.atlassian.net/rest/api/3/

error:
failed to look up existing issues: HTTP request to JIRA API: unexpected status code 410: {\"errorMessages\":[\"L'API demandée a été supprimée. Veuillez migrer vers l'API /rest/api/3/search/jql

[lerminou]

Ok there is another PR merged instead of this one

[holger-waschke]

Ok there is another PR merged instead of this one

yes, superseded by #4542