REST API POST /rest/api/3/issueLink - Documentation incorrectly states comment is added to "from (outward) issue" when it is actually added to the inward issue

XMLWordPrintable

    • 1
    • Minor

      Issue Summary

      The Jira REST API documentation for POST /rest/api/3/issueLink contains incorrect/misleading information about which issue receives the comment when creating an issue link with a comment. The documentation states the comment is added to the "from (outward) issue", but the actual behavior is that the comment is added to the inward issue.

      Steps to Reproduce

      1. Use the POST /rest/api/3/issueLink (or /rest/api/2/issueLink) endpoint with the following request body

      {
        "type": {
          "name": "Blocks"
        },
        "inwardIssue": {
          "key": "CMPN2-959"
        },
        "outwardIssue": {
          "key": "CMPN2-515"
        },
        "comment": {
          "body": "Linking these issues as Blocks.",
          "visibility": {
            "type": "group",
            "value": "jira-software-users-kunal-kishore"
          }
        }
      }
      

      2. Check which issue received the comment.

      Expected Results

      Based on the API documentation which states: "Creates a link between two issues. Use this operation to indicate a relationship between two issues and optionally add a comment to the from (outward) issue." — the comment should be added to the outward issue (CMPN2-515).

      Actual Results

      The comment is added to the inward issue (CMPN2-959), NOT the outward issue (CMPN2-515).

      Suggested Documentation Fix

      The REST API documentation for POST  /rest/api/3/issueLink should be updated to something like: "Use this operation to indicate a relationship between two issues and optionally add a comment to the inward issue."

        1. Linked Issue-1.png
          Linked Issue-1.png
          376 kB
        2. Work item linking.png
          Work item linking.png
          165 kB

              Assignee:
              Unassigned
              Reporter:
              Kunal Kishore
              Votes:
              1 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated: