Sentry · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sentry Integrations External Teams API

4 actions 4 updates phrasing extends openapi/sentry-system-external-teams-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['/organizations/{organization_id_or_slug}/external-teams/'].post
$.paths['/organizations/{organization_id_or_slug}/external-teams/{external_team_id}/'].put
$.paths['/organizations/{organization_id_or_slug}/external-teams/{external_team_id}/'].delete

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Sentry Integrations External Teams API
  version: 1.0.0
extends: openapi/sentry-system-external-teams-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['/organizations/{organization_id_or_slug}/external-teams/'].post
  update:
    x-apievangelist-phrasing:
      intent: Map a team to an external service team
      effect: write
      questions:
      - How do I link a Sentry team to a team in our chat or code hosting tool?
      - What is needed to create an external team mapping?
      instructions:
      - text: Map Sentry team {teamId} to external team {externalName} on {provider} in {org}.
        slots:
          teamId: requestBody.teamId
          externalName: requestBody.externalName
          provider: requestBody.provider
          org: path.organization_id_or_slug
      - text: Link team {teamId} to {externalName} via integration {integrationId}.
        slots:
          teamId: requestBody.teamId
          externalName: requestBody.externalName
          integrationId: requestBody.integrationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/external-teams/{external_team_id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an external team mapping
      effect: write
      questions:
      - Can I change the external name a team is mapped to?
      - How do I fix a wrong external team mapping?
      instructions:
      - text: Change external team mapping {external_team_id} in {org} to name {externalName}.
        slots:
          external_team_id: path.external_team_id
          org: path.organization_id_or_slug
          externalName: requestBody.externalName
      - text: Switch external team {external_team_id} to provider {provider}.
        slots:
          external_team_id: path.external_team_id
          provider: requestBody.provider
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/external-teams/{external_team_id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an external team mapping
      effect: destructive
      questions:
      - How do I unlink a Sentry team from its external team?
      - Does deleting a team mapping delete the Sentry team itself?
      instructions:
      - text: Delete external team mapping {external_team_id} from {org}.
        slots:
          external_team_id: path.external_team_id
          org: path.organization_id_or_slug
      - text: Remove external team link {external_team_id}.
        slots:
          external_team_id: path.external_team_id
      method: generated
      generated: '2026-09-26'