Sentry · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sentry Alerts Metric Alerts API

6 actions 6 updates phrasing extends openapi/sentry-system-metric-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['/organizations/{organization_id_or_slug}/alert-rules/'].get

$.paths['/organizations/{organization_id_or_slug}/alert-rules/'].post

$.paths['/organizations/{organization_id_or_slug}/alert-rules/{alert_rule_id}/'].get

$.paths['/organizations/{organization_id_or_slug}/alert-rules/{alert_rule_id}/'].put

$.paths['/organizations/{organization_id_or_slug}/alert-rules/{alert_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 Metric Alerts API
  version: 1.0.0
extends: openapi/sentry-system-metric-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['/organizations/{organization_id_or_slug}/alert-rules/'].get
  update:
    x-apievangelist-phrasing:
      intent: List metric alert rules
      effect: read
      questions:
      - Which metric alerts watch error rates or latency in my org?
      - Can I page through all metric alert rules?
      instructions:
      - text: List metric alert rules in organization {org}.
        slots:
          org: path.organization_id_or_slug
      - text: Show the next page of metric alerts in {org} from 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}/alert-rules/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a metric alert rule
      effect: write
      questions:
      - How do I alert when p95 latency crosses a threshold?
      - What triggers and time window does a metric alert need?
      instructions:
      - text: Create metric alert {name} in {org} on {aggregate} over {timeWindow} minutes with triggers {triggers}.
        slots:
          name: requestBody.name
          org: path.organization_id_or_slug
          aggregate: requestBody.aggregate
          timeWindow: requestBody.timeWindow
          triggers: requestBody.triggers
      - text: Add metric alert {name} for projects {projects} filtered by {query} in {environment}.
        slots:
          name: requestBody.name
          projects: requestBody.projects
          query: requestBody.query
          environment: requestBody.environment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/alert-rules/{alert_rule_id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a metric alert rule
      effect: read
      questions:
      - What thresholds does a particular metric alert use?
      - Can I view one metric alert rule by ID?
      instructions:
      - text: Show metric alert rule {alert_rule_id} in {org}.
        slots:
          alert_rule_id: path.alert_rule_id
          org: path.organization_id_or_slug
      - text: Fetch metric alert {alert_rule_id}.
        slots:
          alert_rule_id: path.alert_rule_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/alert-rules/{alert_rule_id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a metric alert rule
      effect: write
      questions:
      - How do I change the threshold on an existing metric alert?
      - Can I reassign the owner of a metric alert?
      instructions:
      - text: Update triggers of metric alert {alert_rule_id} in {org} to {triggers}.
        slots:
          alert_rule_id: path.alert_rule_id
          org: path.organization_id_or_slug
          triggers: requestBody.triggers
      - text: Change metric alert {alert_rule_id} owner to {owner}.
        slots:
          alert_rule_id: path.alert_rule_id
          owner: requestBody.owner
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/alert-rules/{alert_rule_id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a metric alert rule
      effect: destructive
      questions:
      - How do I remove a metric alert that's too noisy?
      - Is deleting a metric alert rule permanent?
      instructions:
      - text: Delete metric alert rule {alert_rule_id} from {org}.
        slots:
          alert_rule_id: path.alert_rule_id
          org: path.organization_id_or_slug
      - text: Remove metric alert {alert_rule_id}.
        slots:
          alert_rule_id: path.alert_rule_id
      method: generated
      generated: '2026-09-26'