Sentry · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sentry Monitors Alerts API

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

$.info
$.paths['/organizations/{organization_id_or_slug}/alerts/'].get
$.paths['/organizations/{organization_id_or_slug}/alerts/'].put
$.paths['/organizations/{organization_id_or_slug}/alerts/'].post
$.paths['/organizations/{organization_id_or_slug}/alerts/'].delete
$.paths['/organizations/{organization_id_or_slug}/alerts/{alert_id}/'].get
$.paths['/organizations/{organization_id_or_slug}/alerts/{alert_id}/'].put
$.paths['/organizations/{organization_id_or_slug}/alerts/{alert_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 Monitors Alerts API
  version: 1.0.0
extends: openapi/sentry-system-alerts-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: 7
- target: $.paths['/organizations/{organization_id_or_slug}/alerts/'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's alerts
      effect: read
      questions:
      - Which alerts are set up across my Sentry organization?
      - Can I page through every alert my org has configured?
      instructions:
      - text: List all alerts in organization {org}.
        slots:
          org: path.organization_id_or_slug
      - text: Show the next page of alerts for {org} starting at cursor {cursor}.
        slots:
          org: path.organization_id_or_slug
          cursor: query.cursor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/alerts/'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk update alert status
      effect: write
      questions:
      - How do I change the status of several alerts at once?
      - Is there a way to mute or enable a batch of alerts in one call?
      instructions:
      - text: Set the status of alerts {ids} in {org} to {status}.
        slots:
          ids: requestBody.ids
          org: path.organization_id_or_slug
          status: requestBody.status
      - text: Bulk change status to {status} for every alert listed in {ids}.
        slots:
          status: requestBody.status
          ids: requestBody.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/alerts/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an organization alert
      effect: write
      questions:
      - How can I add a new alert to my organization?
      - What do I need to supply to create an alert besides a name?
      instructions:
      - text: Create an alert named {name} in organization {org}.
        slots:
          name: requestBody.name
          org: path.organization_id_or_slug
      - text: Add a new org-level alert called {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/alerts/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several alerts at once
      effect: destructive
      questions:
      - Can I remove multiple alerts in a single request?
      - Is bulk deletion of alerts permanent?
      instructions:
      - text: Bulk delete alerts {id} from organization {org}.
        slots:
          id: query.id
          org: path.organization_id_or_slug
      - text: Remove all the alerts with ids {id} in one go.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/alerts/{alert_id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one alert's details
      effect: read
      questions:
      - What is configured on a specific alert?
      - Where can I see the full details of a single alert by its ID?
      instructions:
      - text: Show alert {alert_id} in organization {org}.
        slots:
          alert_id: path.alert_id
          org: path.organization_id_or_slug
      - text: Fetch the details of alert {alert_id}.
        slots:
          alert_id: path.alert_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/alerts/{alert_id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or update an alert
      effect: write
      questions:
      - How do I rename an existing alert?
      - Can I edit a single alert without touching the others?
      instructions:
      - text: Rename alert {alert_id} in {org} to {name}.
        slots:
          alert_id: path.alert_id
          org: path.organization_id_or_slug
          name: requestBody.name
      - text: Update alert {alert_id} with the name {name}.
        slots:
          alert_id: path.alert_id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/alerts/{alert_id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a single alert
      effect: destructive
      questions:
      - How do I get rid of one alert I no longer need?
      - What happens when I delete one specific alert by ID?
      instructions:
      - text: Delete alert {alert_id} from organization {org}.
        slots:
          alert_id: path.alert_id
          org: path.organization_id_or_slug
      - text: Remove the alert {alert_id}.
        slots:
          alert_id: path.alert_id
      method: generated
      generated: '2026-09-26'