# 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 Remote Links…
  version: 1.0.0
extends: openapi/atlassian-issue-remote-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: 6
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/remotelink'].get
  update:
    x-apievangelist-phrasing:
      intent: List the remote links on an issue
      effect: read
      questions:
      - What external items, like support tickets or docs, are linked to a Jira issue?
      - Can I find a remote link on an issue by its global ID?
      instructions:
      - text: List the remote links on issue {issueIdOrKey}.
        slots:
          issueIdOrKey: path.issueIdOrKey
      - text: Find the remote link with global ID {globalId} on {issueIdOrKey}.
        slots:
          globalId: query.globalId
          issueIdOrKey: path.issueIdOrKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/remotelink'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or upsert a remote link on an issue
      effect: write
      questions:
      - How do I link an issue to a page or record in another system?
      - Will adding a remote link with an existing global ID update it instead of duplicating?
      instructions:
      - text: Link issue {issueIdOrKey} to the external item {object}.
        slots:
          issueIdOrKey: path.issueIdOrKey
          object: requestBody.object
      - text: Create or update the remote link {globalId} on {issueIdOrKey} pointing to {object}.
        slots:
          globalId: requestBody.globalId
          issueIdOrKey: path.issueIdOrKey
          object: requestBody.object
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/remotelink'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a remote link by its global ID
      effect: destructive
      questions:
      - How do I remove an external link from an issue when I only know its global ID?
      - Do reserved URL characters in a global ID need escaping when deleting a link?
      instructions:
      - text: Delete the remote link with global ID {globalId} from issue {issueIdOrKey}.
        slots:
          globalId: query.globalId
          issueIdOrKey: path.issueIdOrKey
      - text: Unlink external item {globalId} from {issueIdOrKey}.
        slots:
          globalId: query.globalId
          issueIdOrKey: path.issueIdOrKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/remotelink/{linkId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a remote issue link by its link ID
      effect: read
      questions:
      - What does a specific remote link on an issue point to?
      - Can I fetch a single remote link using its numeric link ID?
      instructions:
      - text: Get remote link {linkId} on issue {issueIdOrKey}.
        slots:
          linkId: path.linkId
          issueIdOrKey: path.issueIdOrKey
      - text: Show where remote link {linkId} of {issueIdOrKey} points.
        slots:
          linkId: path.linkId
          issueIdOrKey: path.issueIdOrKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/remotelink/{linkId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a remote issue link by its link ID
      effect: write
      questions:
      - How do I change the target or relationship of an existing remote link?
      - Are fields I leave out cleared when updating a remote link by ID?
      instructions:
      - text: Update remote link {linkId} on issue {issueIdOrKey} to point to {object}.
        slots:
          linkId: path.linkId
          issueIdOrKey: path.issueIdOrKey
          object: requestBody.object
      - text: Change the relationship of link {linkId} on {issueIdOrKey} to {relationship} for {object}.
        slots:
          linkId: path.linkId
          issueIdOrKey: path.issueIdOrKey
          relationship: requestBody.relationship
          object: requestBody.object
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/remotelink/{linkId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a remote issue link by its link ID
      effect: destructive
      questions:
      - How do I delete one remote link from an issue using its link ID?
      - Does removing a remote link require issue linking to be enabled?
      instructions:
      - text: Delete remote link {linkId} from issue {issueIdOrKey}.
        slots:
          linkId: path.linkId
          issueIdOrKey: path.issueIdOrKey
      - text: Remove the remote link numbered {linkId} on {issueIdOrKey}.
        slots:
          linkId: path.linkId
          issueIdOrKey: path.issueIdOrKey
      method: generated
      generated: '2026-10-01'