Skip to content

Explain why JIRA DVCS requires API write-access

What does this MR do?

The DVCS connector uses the application token over GitLab API calls to perform some of its required webhook configuration.

For this to succeed, the wider api scope needs to be selected instead of the limited read_api scope.

The integration cannot function successfully if the read-only scope is provided instead.

This change adds a nested line in the instructions that setup the scope explaining why the scope is required by the connector.

The doc-note was added after discussion over Slack with the connector devs over channel #f_jira: https://gitlab.slack.com/archives/C2G2VTZPA/p1635943124008300?thread_ts=1634890224.004900&cid=C2G2VTZPA

Related issues

Issue: #343942 (closed)

Customer tickets:

Author's checklist

If you are only adding documentation, do not add any of the following labels:

  • ~"type::feature"
  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Review checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  • Ensure a release milestone is set.
Edited by Harsh Chouraria

Merge request reports