Sentry · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sentry and Issues Events API

6 actions 6 updates phrasing extends openapi/sentry-system-events-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['/issues/{issue_id}/events/'].get

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

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

$.paths['/issues/{issue_id}/events/{event_id}/'].get

$.paths['/projects/{organization_id_or_slug}/{project_id_or_slug}/events/{event_id}/source-map-debug/'].get

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 and Issues Events API
  version: 1.0.0
extends: openapi/sentry-system-events-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['/issues/{issue_id}/events/'].get
  update:
    x-apievangelist-phrasing:
      intent: List events for an issue
      effect: read
      questions:
      - What individual events make up an issue?
      - Can I get full event bodies for every occurrence of an issue?
      instructions:
      - text: List events for issue {issue_id}.
        slots:
          issue_id: path.issue_id
      - text: List events for issue {issue_id} with full details set to {full}.
        slots:
          issue_id: path.issue_id
          full: query.full
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{organization_id_or_slug}/{project_id_or_slug}/events/'].get
  update:
    x-apievangelist-phrasing:
      intent: List a project's error events
      effect: read
      questions:
      - Which error events came into a project recently?
      - Can I page through raw events for a whole project?
      instructions:
      - text: List error events for project {project} in {org}.
        slots:
          project: path.project_id_or_slug
          org: path.organization_id_or_slug
      - text: Show the next page of project {project} events from cursor {cursor}.
        slots:
          project: path.project_id_or_slug
          cursor: query.cursor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{organization_id_or_slug}/{project_id_or_slug}/events/{event_id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an event from a project
      effect: read
      questions:
      - How can I read the full payload of one event in a project?
      - Where do I see the stack trace for a specific event ID?
      instructions:
      - text: Show event {event_id} from project {project} in {org}.
        slots:
          event_id: path.event_id
          project: path.project_id_or_slug
          org: path.organization_id_or_slug
      - text: Fetch project {project}'s event {event_id}.
        slots:
          project: path.project_id_or_slug
          event_id: path.event_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/issues/{issue_id}/events/{event_id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a specific event of an issue
      effect: read
      questions:
      - Can I pull one event by ID through its issue?
      - What does a particular occurrence within an issue look like?
      instructions:
      - text: Show event {event_id} of issue {issue_id}.
        slots:
          event_id: path.event_id
          issue_id: path.issue_id
      - text: Fetch occurrence {event_id} belonging to issue {issue_id}.
        slots:
          event_id: path.event_id
          issue_id: path.issue_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{organization_id_or_slug}/{project_id_or_slug}/events/{event_id}/source-map-debug/'].get
  update:
    x-apievangelist-phrasing:
      intent: Troubleshoot source maps for an event
      effect: read
      questions:
      - Why is my JavaScript stack trace still minified?
      - How can I check whether source maps were applied to an event?
      instructions:
      - text: Debug source map processing for event {event_id} in project {project} of {org}.
        slots:
          event_id: path.event_id
          project: path.project_id_or_slug
          org: path.organization_id_or_slug
      - text: Explain why event {event_id} did not resolve source maps.
        slots:
          event_id: path.event_id
      method: generated
      generated: '2026-09-26'