# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Jira Cloud platform REST Issue remote links API
  version: 1.0.0
extends: openapi/jira-issue-remote-links-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      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 an issue's remote links
      effect: read
      questions:
      - What external web links are attached to an issue?
      - Can I look up 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 issue {issueIdOrKey}.
        slots:
          globalId: query.globalId
          issueIdOrKey: path.issueIdOrKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/remotelink'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or upsert a remote issue link
      effect: write
      questions:
      - How do I attach an external link, like a support ticket, to an issue?
      - Will posting a remote link with an existing global ID update it instead of duplicating it?
      instructions:
      - text: Add remote link {object} to issue {issueIdOrKey}.
        slots:
          object: requestBody.object
          issueIdOrKey: path.issueIdOrKey
      - text: Upsert the remote link with global ID {globalId} on issue {issueIdOrKey} to {object}.
        slots:
          globalId: requestBody.globalId
          issueIdOrKey: path.issueIdOrKey
          object: requestBody.object
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/remotelink'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a remote link by global ID
      effect: destructive
      questions:
      - Can I remove a remote link using its global ID rather than its link ID?
      - Do reserved 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: Remove external link {globalId} (by global ID) from {issueIdOrKey}.
        slots:
          globalId: query.globalId
          issueIdOrKey: path.issueIdOrKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/remotelink/{linkId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a remote issue link by ID
      effect: read
      questions:
      - Can I fetch a single remote link on an issue by its numeric link ID?
      - What URL and title does a particular remote link point to?
      instructions:
      - text: Get remote link {linkId} on issue {issueIdOrKey}.
        slots:
          issueIdOrKey: path.issueIdOrKey
          linkId: path.linkId
      - text: Show the URL behind remote link {linkId} on {issueIdOrKey}.
        slots:
          issueIdOrKey: path.issueIdOrKey
          linkId: path.linkId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/remotelink/{linkId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a remote issue link by ID
      effect: write
      questions:
      - Can I change the target of an existing remote link by its link ID?
      - Are omitted fields cleared when updating a remote issue link?
      instructions:
      - text: Update remote link {linkId} on issue {issueIdOrKey} to {object}.
        slots:
          linkId: path.linkId
          issueIdOrKey: path.issueIdOrKey
          object: requestBody.object
      - text: Change remote link {linkId} on {issueIdOrKey} to relationship {relationship} and object {object}.
        slots:
          linkId: path.linkId
          issueIdOrKey: path.issueIdOrKey
          relationship: requestBody.relationship
          object: requestBody.object
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/remotelink/{linkId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a remote issue link by ID
      effect: destructive
      questions:
      - Can I delete a remote link from an issue using its link ID?
      - What permissions are needed to remove a remote link from an issue?
      instructions:
      - text: Delete remote link {linkId} from issue {issueIdOrKey}.
        slots:
          issueIdOrKey: path.issueIdOrKey
          linkId: path.linkId
      - text: Remove link ID {linkId} from the remote links on {issueIdOrKey}.
        slots:
          issueIdOrKey: path.issueIdOrKey
          linkId: path.linkId
      method: generated
      generated: '2026-09-26'