-
Type:
Bug
-
Resolution: Unresolved
-
Priority:
Low
-
Component/s: Work Item - Backend - Work Item Links
-
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."