Sentry · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sentry Alerts Spike Protection API

3 actions 3 updates phrasing extends openapi/sentry-system-spike-protection-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 3

$.info
$.paths['/organizations/{organization_id_or_slug}/spike-protections/'].get
$.paths['/organizations/{organization_id_or_slug}/spike-protections/'].post

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 Alerts Spike Protection API
  version: 1.0.0
extends: openapi/sentry-system-spike-protection-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: 2
- target: $.paths['/organizations/{organization_id_or_slug}/spike-protections/'].get
  update:
    x-apievangelist-phrasing:
      intent: List spike protection notifications
      effect: read
      questions:
      - Who gets notified when spike protection kicks in?
      - Which spike protection notification actions are set up?
      instructions:
      - text: List spike protection notification actions for {org}.
        slots:
          org: path.organization_id_or_slug
      - text: Show spike protection alerts configured in {org}.
        slots:
          org: path.organization_id_or_slug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/spike-protections/'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a spike protection notification
      effect: write
      questions:
      - How do I get alerted when a project hits a spike?
      - Can I set spike notifications for specific projects?
      instructions:
      - text: Create a spike protection notification in {org} for projects {projects}.
        slots:
          org: path.organization_id_or_slug
          projects: requestBody.projects
      - text: Notify me about spikes in projects {projects}.
        slots:
          projects: requestBody.projects
      method: generated
      generated: '2026-09-26'