Sentry · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sentry Dashboards API

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

$.paths['/organizations/{organization_id_or_slug}/dashboards/'].post

$.paths['/organizations/{organization_id_or_slug}/dashboards/{dashboard_id}/'].get

$.paths['/organizations/{organization_id_or_slug}/dashboards/{dashboard_id}/'].put

$.paths['/organizations/{organization_id_or_slug}/dashboards/{dashboard_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 Dashboards API
  version: 1.0.0
extends: openapi/sentry-system-dashboards-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}/dashboards/'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom dashboards
      effect: read
      questions:
      - Which custom dashboards exist in my organization?
      - Can I page through all our dashboards?
      instructions:
      - text: List custom dashboards for organization {org}.
        slots:
          org: path.organization_id_or_slug
      - text: Show the next page of dashboards 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}/dashboards/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom dashboard
      effect: write
      questions:
      - How do I create a new dashboard with widgets?
      - Can I build a dashboard with just a title and add widgets later?
      instructions:
      - text: Create a dashboard titled {title} in {org}.
        slots:
          title: requestBody.title
          org: path.organization_id_or_slug
      - text: Create dashboard {title} with widgets {widgets}.
        slots:
          title: requestBody.title
          widgets: requestBody.widgets
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/dashboards/{dashboard_id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a dashboard and its widgets
      effect: read
      questions:
      - What widgets are on a particular dashboard?
      - Can I fetch a single dashboard by its ID?
      instructions:
      - text: Show dashboard {dashboard_id} in organization {org}.
        slots:
          dashboard_id: path.dashboard_id
          org: path.organization_id_or_slug
      - text: Fetch the widgets on dashboard {dashboard_id}.
        slots:
          dashboard_id: path.dashboard_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/dashboards/{dashboard_id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a custom dashboard
      effect: write
      questions:
      - How do I retitle an existing dashboard?
      - Can I replace the widgets on a dashboard I already made?
      instructions:
      - text: Rename dashboard {dashboard_id} in {org} to {title}.
        slots:
          dashboard_id: path.dashboard_id
          org: path.organization_id_or_slug
          title: requestBody.title
      - text: Replace the widgets on dashboard {dashboard_id} with {widgets}.
        slots:
          dashboard_id: path.dashboard_id
          widgets: requestBody.widgets
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id_or_slug}/dashboards/{dashboard_id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom dashboard
      effect: destructive
      questions:
      - How do I delete a dashboard nobody uses?
      - Will deleting a dashboard remove all its widgets too?
      instructions:
      - text: Delete dashboard {dashboard_id} from {org}.
        slots:
          dashboard_id: path.dashboard_id
          org: path.organization_id_or_slug
      - text: Remove custom dashboard {dashboard_id}.
        slots:
          dashboard_id: path.dashboard_id
      method: generated
      generated: '2026-09-26'