Sentry · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sentry Integration Platform External Issues API

4 actions 4 updates phrasing extends openapi/sentry-system-external-issues-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Sentry's API. It is a proposal applied on top of the contract, not a document Sentry publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/sentry-app-installations/{uuid}/external-issues/'].post

$.paths['/sentry-app-installations/{uuid}/external-issues/{external_issue_id}/'].delete

$.paths['/groups/{issue_id}/external-issues/'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Sentry Integration Platform External Issues API
  version: 1.0.0
extends: openapi/sentry-system-external-issues-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: 3
- target: $.paths['/sentry-app-installations/{uuid}/external-issues/'].post
  update:
    x-apievangelist-phrasing:
      intent: Link a Sentry issue to an external issue
      effect: write
      questions:
      - How can my integration link a Sentry issue to a ticket in our tracker?
      - What details does an external issue link need?
      instructions:
      - text: Link Sentry issue {issueId} to external issue {identifier} at {webUrl} in project {project} for installation {uuid}.
        slots:
          issueId: requestBody.issueId
          identifier: requestBody.identifier
          webUrl: requestBody.webUrl
          project: requestBody.project
          uuid: path.uuid
      - text: Attach ticket {identifier} ({webUrl}) to Sentry issue {issueId} under project {project}.
        slots:
          identifier: requestBody.identifier
          webUrl: requestBody.webUrl
          issueId: requestBody.issueId
          project: requestBody.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sentry-app-installations/{uuid}/external-issues/{external_issue_id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unlink an external issue
      effect: destructive
      questions:
      - Can I remove a tracker link from a Sentry issue?
      - How do I undo an external issue link my integration made?
      instructions:
      - text: Delete external issue link {external_issue_id} for installation {uuid}.
        slots:
          external_issue_id: path.external_issue_id
          uuid: path.uuid
      - text: Unlink external issue {external_issue_id}.
        slots:
          external_issue_id: path.external_issue_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/groups/{issue_id}/external-issues/'].get
  update:
    x-apievangelist-phrasing:
      intent: List external links on an issue
      effect: read
      questions:
      - Which tracker tickets are linked to a Sentry issue?
      - Does this issue already have a custom integration ticket?
      instructions:
      - text: List external issue links for Sentry issue {issue_id}.
        slots:
          issue_id: path.issue_id
      - text: Show the tickets linked to issue {issue_id}.
        slots:
          issue_id: path.issue_id
      method: generated
      generated: '2026-09-26'