Sentry · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sentry Integrations Data Forwarders API

5 actions 5 updates phrasing extends openapi/sentry-system-data-forwarders-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}/data-forwarders/'].get
$.paths['/organizations/{organization_id_or_slug}/data-forwarders/'].post
$.paths['/organizations/{organization_id_or_slug}/data-forwarders/{forwarder_id}/'].put
$.paths['/organizations/{organization_id_or_slug}/data-forwarders/{forwarder_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 Data Forwarders API
  version: 1.0.0
extends: openapi/sentry-system-data-forwarders-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}/data-forwarders/'].get
  update:
    x-apievangelist-phrasing:
      intent: List data forwarders
      effect: read
      questions:
      - Which data forwarders are configured for my organization?
      - Where is my Sentry data being forwarded to?
      instructions:
      - text: List data forwarders in organization {org}.
        slots:
          org: path.organization_id_or_slug
      - text: Show all configured forwarders for {org}.
        slots:
          org: path.organization_id_or_slug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/data-forwarders/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a data forwarder
      effect: write
      questions:
      - How do I set up a new data forwarder?
      - Can I name a forwarder when I create it?
      instructions:
      - text: Create a data forwarder named {name} in {org}.
        slots:
          name: requestBody.name
          org: path.organization_id_or_slug
      - text: Add a new forwarder called {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/data-forwarders/{forwarder_id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a data forwarder
      effect: write
      questions:
      - Can I rename an existing data forwarder?
      - How do I change the settings of a forwarder I already set up?
      instructions:
      - text: Rename data forwarder {forwarder_id} in {org} to {name}.
        slots:
          forwarder_id: path.forwarder_id
          org: path.organization_id_or_slug
          name: requestBody.name
      - text: Update forwarder {forwarder_id}.
        slots:
          forwarder_id: path.forwarder_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/data-forwarders/{forwarder_id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a data forwarder
      effect: destructive
      questions:
      - How do I stop forwarding data by removing a forwarder?
      - Is removing a data forwarder permanent?
      instructions:
      - text: Delete data forwarder {forwarder_id} from {org}.
        slots:
          forwarder_id: path.forwarder_id
          org: path.organization_id_or_slug
      - text: Remove forwarder {forwarder_id}.
        slots:
          forwarder_id: path.forwarder_id
      method: generated
      generated: '2026-09-26'