Sentry · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sentry Replays API

6 actions 6 updates phrasing extends openapi/sentry-system-replays-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}/replays/'].get

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

$.paths['/projects/{organization_id_or_slug}/{project_id_or_slug}/replays/{replay_id}/'].delete

$.paths['/projects/{organization_id_or_slug}/{project_id_or_slug}/replays/{replay_id}/viewed-by/'].get

$.paths['/organizations/{organization_id_or_slug}/replay-count/'].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 Replays API
  version: 1.0.0
extends: openapi/sentry-system-replays-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}/replays/'].get
  update:
    x-apievangelist-phrasing:
      intent: List session replays
      effect: read
      questions:
      - How do I find session replays from the last day?
      - Can I filter replays by project and environment and sort them?
      instructions:
      - text: List replays in organization {org}.
        slots:
          org: path.organization_id_or_slug
      - text: Find replays matching {query} in project {project} over {statsPeriod}, sorted by {sort}.
        slots:
          query: query.query
          project: query.project
          statsPeriod: query.statsPeriod
          sort: query.sort
      - text: Show replays from the {environment} environment.
        slots:
          environment: query.environment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{organization_id_or_slug}/{project_id_or_slug}/replays/{replay_id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a session replay
      effect: read
      questions:
      - What happened during a specific session replay?
      - Can I look up a replay's metadata by ID?
      instructions:
      - text: Show replay {replay_id} in project {project} of {org}.
        slots:
          replay_id: path.replay_id
          project: path.project_id_or_slug
          org: path.organization_id_or_slug
      - text: Fetch details for session replay {replay_id}.
        slots:
          replay_id: path.replay_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{organization_id_or_slug}/{project_id_or_slug}/replays/{replay_id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a session replay
      effect: destructive
      questions:
      - How do I delete a replay that captured sensitive data?
      - Can a session replay be removed permanently?
      instructions:
      - text: Delete replay {replay_id} from project {project} in {org}.
        slots:
          replay_id: path.replay_id
          project: path.project_id_or_slug
          org: path.organization_id_or_slug
      - text: Remove session replay {replay_id}.
        slots:
          replay_id: path.replay_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{organization_id_or_slug}/{project_id_or_slug}/replays/{replay_id}/viewed-by/'].get
  update:
    x-apievangelist-phrasing:
      intent: List who viewed a replay
      effect: read
      questions:
      - Who on my team has already watched this replay?
      - Can I see the viewers of a session replay?
      instructions:
      - text: List users who viewed replay {replay_id} in project {project} of {org}.
        slots:
          replay_id: path.replay_id
          project: path.project_id_or_slug
          org: path.organization_id_or_slug
      - text: Show viewers of replay {replay_id}.
        slots:
          replay_id: path.replay_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/replay-count/'].get
  update:
    x-apievangelist-phrasing:
      intent: Count replays for issues or transactions
      effect: read
      questions:
      - How many replays are attached to an issue?
      - Is there a replay count per transaction for the last week?
      instructions:
      - text: Count replays in {org} for {query}.
        slots:
          org: path.organization_id_or_slug
          query: query.query
      - text: Count replays for {query} in project {project} over {statsPeriod}.
        slots:
          query: query.query
          project: query.project
          statsPeriod: query.statsPeriod
      method: generated
      generated: '2026-09-26'