Sentry · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sentry Alerts Issue Alerts API

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

$.info

$.paths['/projects/{organization_id_or_slug}/{project_id_or_slug}/rules/'].get

$.paths['/projects/{organization_id_or_slug}/{project_id_or_slug}/rules/'].post

$.paths['/projects/{organization_id_or_slug}/{project_id_or_slug}/rules/{rule_id}/'].get

$.paths['/projects/{organization_id_or_slug}/{project_id_or_slug}/rules/{rule_id}/'].put

$.paths['/projects/{organization_id_or_slug}/{project_id_or_slug}/rules/{rule_id}/'].delete

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 Alerts Issue Alerts API
  version: 1.0.0
extends: openapi/sentry-system-issue-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: 5
- target: $.paths['/projects/{organization_id_or_slug}/{project_id_or_slug}/rules/'].get
  update:
    x-apievangelist-phrasing:
      intent: List a project's issue alert rules
      effect: read
      questions:
      - Which issue alert rules are set on my project?
      - What notifications fire when new issues appear in a project?
      instructions:
      - text: List issue alert rules for project {project} in {org}.
        slots:
          project: path.project_id_or_slug
          org: path.organization_id_or_slug
      - text: Show project {project}'s issue alert rules.
        slots:
          project: path.project_id_or_slug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{organization_id_or_slug}/{project_id_or_slug}/rules/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an issue alert rule
      effect: write
      questions:
      - How do I get notified when a new issue is created in a project?
      - Can I limit how often an issue alert fires?
      - What conditions and actions does an issue alert rule need?
      instructions:
      - text: Create issue alert {name} in project {project} of {org} with conditions {conditions}, actions {actions}, match {actionMatch}, frequency {frequency}.
        slots:
          name: requestBody.name
          project: path.project_id_or_slug
          org: path.organization_id_or_slug
          conditions: requestBody.conditions
          actions: requestBody.actions
          actionMatch: requestBody.actionMatch
          frequency: requestBody.frequency
      - text: Add issue alert {name} for the {environment} environment owned by {owner}.
        slots:
          name: requestBody.name
          environment: requestBody.environment
          owner: requestBody.owner
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{organization_id_or_slug}/{project_id_or_slug}/rules/{rule_id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an issue alert rule
      effect: read
      questions:
      - What conditions and actions does a specific issue alert use?
      - Can I view one issue alert rule by its ID?
      instructions:
      - text: Show issue alert rule {rule_id} in project {project} of {org}.
        slots:
          rule_id: path.rule_id
          project: path.project_id_or_slug
          org: path.organization_id_or_slug
      - text: Fetch issue alert rule {rule_id}.
        slots:
          rule_id: path.rule_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{organization_id_or_slug}/{project_id_or_slug}/rules/{rule_id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an issue alert rule
      effect: write
      questions:
      - How can I change the actions on an existing issue alert?
      - Can I reduce the frequency of an issue alert I already have?
      instructions:
      - text: Change the frequency of issue alert rule {rule_id} in project {project} of {org} to {frequency}.
        slots:
          rule_id: path.rule_id
          project: path.project_id_or_slug
          org: path.organization_id_or_slug
          frequency: requestBody.frequency
      - text: Update issue alert {rule_id} to run actions {actions}.
        slots:
          rule_id: path.rule_id
          actions: requestBody.actions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{organization_id_or_slug}/{project_id_or_slug}/rules/{rule_id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an issue alert rule
      effect: destructive
      questions:
      - How do I stop an issue alert from firing permanently?
      - Can I remove an issue alert rule from a project?
      instructions:
      - text: Delete issue alert rule {rule_id} from project {project} in {org}.
        slots:
          rule_id: path.rule_id
          project: path.project_id_or_slug
          org: path.organization_id_or_slug
      - text: Remove issue alert {rule_id}.
        slots:
          rule_id: path.rule_id
      method: generated
      generated: '2026-09-26'