Sentry · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sentry Integrations API

5 actions 5 updates phrasing extends openapi/sentry-system-integrations-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 5

$.info
$.paths['/organizations/{organization_id_or_slug}/integrations/'].get
$.paths['/organizations/{organization_id_or_slug}/integrations/{integration_id}/'].get
$.paths['/organizations/{organization_id_or_slug}/integrations/{integration_id}/'].delete
$.paths['/organizations/{organization_id_or_slug}/config/integrations/'].get

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 API
  version: 1.0.0
extends: openapi/sentry-system-integrations-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: 4
- target: $.paths['/organizations/{organization_id_or_slug}/integrations/'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's integrations
      effect: read
      questions:
      - Which integrations are configured for my organization?
      - Can I filter installed integrations by provider key so I only see one kind?
      instructions:
      - text: List integrations configured in {org}.
        slots:
          org: path.organization_id_or_slug
      - text: Show {org}'s integrations for provider {providerKey}.
        slots:
          org: path.organization_id_or_slug
          providerKey: query.providerKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/integrations/{integration_id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an installed integration
      effect: read
      questions:
      - What are the details of one installed integration?
      - Can I look up an integration by its ID?
      instructions:
      - text: Show integration {integration_id} in {org}.
        slots:
          integration_id: path.integration_id
          org: path.organization_id_or_slug
      - text: Fetch installed integration {integration_id}.
        slots:
          integration_id: path.integration_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/integrations/{integration_id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Uninstall an integration
      effect: destructive
      questions:
      - How do I remove an integration from my organization?
      - What happens when I uninstall an integration?
      instructions:
      - text: Remove integration {integration_id} from {org}.
        slots:
          integration_id: path.integration_id
          org: path.organization_id_or_slug
      - text: Uninstall integration {integration_id}.
        slots:
          integration_id: path.integration_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/config/integrations/'].get
  update:
    x-apievangelist-phrasing:
      intent: List available integration providers
      effect: read
      questions:
      - Which integration providers can I install in Sentry?
      - What configuration does each available integration provider offer?
      instructions:
      - text: Show available integration providers for {org}.
        slots:
          org: path.organization_id_or_slug
      - text: List integration provider configurations {org} could install.
        slots:
          org: path.organization_id_or_slug
      method: generated
      generated: '2026-09-26'