Sentry · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sentry System Organizations API

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

$.info
$.paths['/organizations/'].get
$.paths['/organizations/{organization_id_or_slug}/'].get
$.paths['/organizations/{organization_id_or_slug}/'].put
$.paths['/organizations/{organization_id_or_slug}/projects/'].get
$.paths['/organizations/{organization_id_or_slug}/shortids/{short_id}/'].get
$.paths['/organizations/{organization_id_or_slug}/eventids/{event_id}/'].get
$.paths['/organizations/{organization_id_or_slug}/stats_v2/'].get
$.paths['/organizations/{organization_id_or_slug}/relay_usage/'].get
$.paths['/organizations/{organization_id_or_slug}/client-keys/'].get

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 System Organizations API
  version: 1.0.0
extends: openapi/sentry-system-organizations-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: 9
- target: $.paths['/organizations/'].get
  update:
    x-apievangelist-phrasing:
      intent: List organizations I can access
      effect: read
      questions:
      - Which Sentry organizations does my token have access to?
      - Can I see every org my auth session belongs to?
      instructions:
      - text: List the organizations available to me.
      - text: Show the next page of my organizations from cursor {cursor}.
        slots:
          cursor: query.cursor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an organization's details
      effect: read
      questions:
      - What settings does my organization have?
      - How can I look up an org by its slug?
      instructions:
      - text: Show organization {org}.
        slots:
          org: path.organization_id_or_slug
      - text: Fetch details and settings for org {org}.
        slots:
          org: path.organization_id_or_slug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or update an organization
      effect: write
      questions:
      - How do I rename my organization?
      - Can I change the organization's slug?
      instructions:
      - text: Rename organization {org} to {name}.
        slots:
          org: path.organization_id_or_slug
          name: requestBody.name
      - text: Change organization {org}'s slug to {slug}.
        slots:
          org: path.organization_id_or_slug
          slug: requestBody.slug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/projects/'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's projects
      effect: read
      questions:
      - Which projects exist under my org?
      - Can I page through every project in the organization?
      instructions:
      - text: List projects in organization {org}.
        slots:
          org: path.organization_id_or_slug
      - text: Show the next page of {org}'s projects 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}/shortids/{short_id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Resolve an issue short ID
      effect: read
      questions:
      - How do I turn a short ID like PROJ-123 into an issue?
      - Which project and issue does a short ID belong to?
      instructions:
      - text: Resolve short ID {short_id} in organization {org}.
        slots:
          short_id: path.short_id
          org: path.organization_id_or_slug
      - text: Find the issue behind short ID {short_id}.
        slots:
          short_id: path.short_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/eventids/{event_id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Find the issue for an event ID
      effect: read
      questions:
      - Which project and issue does an event ID belong to?
      - I have an event ID from a log line; where is it in Sentry?
      instructions:
      - text: Resolve event ID {event_id} in organization {org}.
        slots:
          event_id: path.event_id
          org: path.organization_id_or_slug
      - text: Locate the project and issue for event {event_id}.
        slots:
          event_id: path.event_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/stats_v2/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get event counts for an organization
      effect: read
      questions:
      - How many events did my org send in the last 30 days?
      - Can I break event volume down by project?
      instructions:
      - text: Get {field} event counts for {org} over {statsPeriod}.
        slots:
          field: query.field
          org: path.organization_id_or_slug
          statsPeriod: query.statsPeriod
      - text: Show {field} event counts grouped by {groupBy}.
        slots:
          field: query.field
          groupBy: query.groupBy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/relay_usage/'].get
  update:
    x-apievangelist-phrasing:
      intent: List trusted Relays
      effect: read
      questions:
      - Which trusted Relays are registered for my org?
      - Are any self-hosted Relays sending data for us?
      instructions:
      - text: List trusted relays for organization {org}.
        slots:
          org: path.organization_id_or_slug
      - text: Show relay usage in {org}.
        slots:
          org: path.organization_id_or_slug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/client-keys/'].get
  update:
    x-apievangelist-phrasing:
      intent: List client keys across the org
      effect: read
      questions:
      - Can I see every DSN across all projects in my organization?
      - Where do I audit all client keys org-wide?
      instructions:
      - text: List client keys across organization {org}.
        slots:
          org: path.organization_id_or_slug
      - text: Show the next page of org-wide DSNs in {org} from cursor {cursor}.
        slots:
          org: path.organization_id_or_slug
          cursor: query.cursor
      method: generated
      generated: '2026-09-26'