Generated by API Evangelist
Written by API Evangelist tooling for Atlassian's API. It is a proposal applied on top of the contract, not a document Atlassian publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Atlassian The Jira Cloud platform REST Issue Links API
version: 1.0.0
extends: openapi/atlassian-issue-links-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/rest/api/3/issueLink'].post
update:
x-apievangelist-phrasing:
intent: Link two Jira issues
effect: write
questions:
- How do I mark one Jira issue as blocking another?
- Can I add a comment while linking two issues?
instructions:
- text: Link {outwardIssue} to {inwardIssue} with link type {type}.
slots:
outwardIssue: requestBody.outwardIssue
inwardIssue: requestBody.inwardIssue
type: requestBody.type
- text: Mark {inwardIssue} and {outwardIssue} as related by {type} and comment {comment}.
slots:
inwardIssue: requestBody.inwardIssue
outwardIssue: requestBody.outwardIssue
type: requestBody.type
comment: requestBody.comment
method: generated
generated: '2026-10-01'
- target: $.paths['/rest/api/3/issueLink/{linkId}'].get
update:
x-apievangelist-phrasing:
intent: Get an issue link
effect: read
questions:
- Which two issues does a specific issue link connect, and how?
- Can I look up a single link between issues by its ID?
instructions:
- text: Get issue link {linkId}.
slots:
linkId: path.linkId
- text: Show the issues and link type behind link {linkId}.
slots:
linkId: path.linkId
method: generated
generated: '2026-10-01'
- target: $.paths['/rest/api/3/issueLink/{linkId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an issue link
effect: destructive
questions:
- How do I unlink two Jira issues?
- What permissions do I need to remove a link between issues?
instructions:
- text: Delete issue link {linkId}.
slots:
linkId: path.linkId
- text: Remove the link {linkId} between those two issues.
slots:
linkId: path.linkId
method: generated
generated: '2026-10-01'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.