diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2023-12-18 12:14:26 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2023-12-18 12:14:26 +0300 |
commit | 92de2642b384f7d6ac3bf3c1f0862b067306c9be (patch) | |
tree | a9a7c3305edbb11360b7d8c92b9297739a2d39df /doc/integration | |
parent | f5eac201c2b887d75800674ad5663d1cda8cbeb9 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/integration')
-rw-r--r-- | doc/integration/jira/connect-app.md | 5 | ||||
-rw-r--r-- | doc/integration/jira/troubleshooting.md | 21 |
2 files changed, 24 insertions, 2 deletions
diff --git a/doc/integration/jira/connect-app.md b/doc/integration/jira/connect-app.md index a048541954d..6f6a882031a 100644 --- a/doc/integration/jira/connect-app.md +++ b/doc/integration/jira/connect-app.md @@ -14,6 +14,11 @@ With the [GitLab for Jira Cloud](https://marketplace.atlassian.com/apps/1221011/ You can use the GitLab for Jira Cloud app to link top-level groups or subgroups. It's not possible to directly link projects or personal namespaces. To set up the GitLab for Jira Cloud app on GitLab.com, [install the GitLab for Jira Cloud app](#install-the-gitlab-for-jira-cloud-app). + +After you set up the app, you can use the [project toolchain](https://support.atlassian.com/jira-software-cloud/docs/what-is-the-project-toolchain-in-jira) +developed and maintained by Atlassian to [link GitLab repositories to Jira projects](https://support.atlassian.com/jira-software-cloud/docs/link-repositories-to-a-project/#Link-repositories-using-the-toolchain-feature). +The project toolchain does not affect how development information is synced between GitLab and Jira Cloud. + For Jira Data Center or Jira Server, use the [Jira DVCS connector](dvcs/index.md) developed and maintained by Atlassian. ## GitLab data synced to Jira diff --git a/doc/integration/jira/troubleshooting.md b/doc/integration/jira/troubleshooting.md index ab9a750605d..0487c20af74 100644 --- a/doc/integration/jira/troubleshooting.md +++ b/doc/integration/jira/troubleshooting.md @@ -35,10 +35,13 @@ If you [restrict IP addresses for Jira access](https://support.atlassian.com/sec For the root cause, check the [`integrations_json.log`](../../administration/logs/index.md#integrations_jsonlog) file. When GitLab tries to comment on a Jira issue, an `Error sending message` log entry might appear. -In GitLab 16.1 and later, when an error occurs, the [`integrations_json.log`](../../administration/logs/index.md#integrations_jsonlog) file contains `client_*` keys in the outgoing API request to Jira. +In GitLab 16.1 and later, when an error occurs, the `integrations_json.log` file contains `client_*` keys in the outgoing API request to Jira. You can use the `client_*` keys to check the [Atlassian API documentation](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/#api-group-issues) for why the error has occurred. -In the following example, Jira responds with a `404` because the Jira issue `ALPHA-1` does not exist: +In the following example, Jira responds with a `404`. This error might happen if: + +- The Jira user you created for the Jira issue integration does not have permission to view the issue. +- The Jira issue ID you specified does not exist. ```json { @@ -53,6 +56,18 @@ In the following example, Jira responds with a `404` because the Jira issue `ALP } ``` +For more information about returned status codes, see the [Jira Cloud platform REST API documentation](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issues/#api-rest-api-2-issue-issueidorkey-get-response). + +#### Using `curl` to verify access to a Jira issue + +To verify that a Jira user can access a specific Jira issue, run the following script: + +```shell +curl --verbose --user "$USER:$API_TOKEN" "https://$ATLASSIAN_SUBDOMAIN.atlassian.net/rest/api/2/issue/$JIRA_ISSUE" +``` + +If the user can access the issue, Jira responds with a `200` and the returned JSON includes the Jira issue details. + ### GitLab cannot close a Jira issue If GitLab cannot close a Jira issue: @@ -260,3 +275,5 @@ Both methods should return a JSON response: - `total` gives a count of the issues that match the Jira project key. - `issues` contains an array of the issues that match the Jira project key. + +For more information about returned status codes, see the [Jira Cloud platform REST API documentation](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issues/#api-rest-api-2-issue-issueidorkey-get-response). |