# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Console Dashboards API
  version: 1.0.0
extends: openapi/statsig-dashboards-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/console/v1/dashboards'].get
  update:
    x-apievangelist-phrasing:
      intent: List or search dashboards
      effect: read
      questions:
      - What dashboards do we have?
      - Can I find a dashboard by part of its name?
      instructions:
      - text: List all dashboards.
      - text: Search dashboards whose name contains {search}.
        slots:
          search: query.search
      method: generated
      generated: '2026-10-01'
- target: $.paths['/console/v1/dashboards'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a dashboard
      effect: write
      questions:
      - How do I build a new dashboard through the API?
      - Can I include widgets when I first create a dashboard?
      instructions:
      - text: Create a dashboard named {name}.
        slots:
          name: requestBody.name
      - text: Create dashboard {name} described as {description} with widgets {widgets}.
        slots:
          name: requestBody.name
          description: requestBody.description
          widgets: requestBody.widgets
      method: generated
      generated: '2026-10-01'
- target: $.paths['/console/v1/dashboards/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a dashboard
      effect: read
      questions:
      - Which widgets are on a particular dashboard?
      - What does one dashboard's layout look like?
      instructions:
      - text: Show dashboard {id}.
        slots:
          id: path.id
      - text: Get the widgets and settings of dashboard {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/console/v1/dashboards/{id}/widgets'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace all widgets on a dashboard
      effect: write
      questions:
      - Can I swap out every widget on a dashboard at once?
      - Will replacing widgets remove the ones already there?
      instructions:
      - text: Replace all widgets on dashboard {id} with {widgets}.
        slots:
          id: path.id
          widgets: requestBody.widgets
      - text: Rebuild dashboard {id} from scratch using widgets {widgets} in {max_cols} columns.
        slots:
          id: path.id
          widgets: requestBody.widgets
          max_cols: requestBody.max_cols
      method: generated
      generated: '2026-10-01'
- target: $.paths['/console/v1/dashboards/{id}/widgets'].post
  update:
    x-apievangelist-phrasing:
      intent: Add widgets to a dashboard
      effect: write
      questions:
      - How do I append a chart to an existing dashboard?
      - Can I add widgets while keeping the current ones?
      instructions:
      - text: Add widgets {widgets} to dashboard {id}.
        slots:
          id: path.id
          widgets: requestBody.widgets
      - text: Append these new charts {widgets} to dashboard {id}, keeping existing ones.
        slots:
          id: path.id
          widgets: requestBody.widgets
      method: generated
      generated: '2026-10-01'
- target: $.paths['/console/v1/dashboards/{id}/widgets/{widgetId}/results'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a dashboard widget's data
      effect: read
      questions:
      - Can I pull the numbers behind one dashboard chart?
      - Is funnel sampling on by default when reading widget results?
      instructions:
      - text: Get results for widget {widgetId} on dashboard {id}.
        slots:
          id: path.id
          widgetId: path.widgetId
      - text: Fetch widget {widgetId} data from dashboard {id} with sampling {sampling_enabled}.
        slots:
          id: path.id
          widgetId: path.widgetId
          sampling_enabled: query.sampling_enabled
      method: generated
      generated: '2026-10-01'