Power BI · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Power BI REST Dashboards API

7 actions 7 updates phrasing extends openapi/power-bi-dashboards-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Power BI's API. It is a proposal applied on top of the contract, not a document Power BI publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/dashboards'].get
$.paths['/dashboards'].post
$.paths['/dashboards/{dashboardId}'].get
$.paths['/dashboards/{dashboardId}/tiles'].get
$.paths['/dashboards/{dashboardId}/tiles/{tileId}'].get
$.paths['/groups/{groupId}/dashboards'].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 Power BI REST Dashboards API
  version: 1.0.0
extends: openapi/power-bi-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['/dashboards'].get
  update:
    x-apievangelist-phrasing:
      intent: List dashboards in My Workspace
      effect: read
      questions:
      - What dashboards are in my personal My Workspace?
      - Which of my own dashboards are read-only?
      instructions:
      - text: List the dashboards in My Workspace.
      - text: Show me embed URLs for all dashboards in My Workspace.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dashboards'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an empty dashboard
      effect: write
      questions:
      - How do I create a new blank dashboard in My Workspace?
      - Can I make an empty dashboard and pin tiles to it later?
      instructions:
      - text: Create a dashboard named {name}.
        slots:
          name: requestBody.name
      - text: Make a new empty dashboard called {name} in My Workspace.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dashboards/{dashboardId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a dashboard's details
      effect: read
      questions:
      - Where do I find the embed URL for one specific dashboard?
      - Can I look up a single dashboard's configuration by its ID?
      instructions:
      - text: Get dashboard {dashboardId}.
        slots:
          dashboardId: path.dashboardId
      - text: Show me the name and embed URL of dashboard {dashboardId}.
        slots:
          dashboardId: path.dashboardId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dashboards/{dashboardId}/tiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List tiles on a dashboard
      effect: read
      questions:
      - Which visualizations are pinned to a given dashboard?
      - Can I see which reports and datasets a dashboard's tiles come from?
      instructions:
      - text: List the tiles on dashboard {dashboardId}.
        slots:
          dashboardId: path.dashboardId
      - text: Show every pinned tile on dashboard {dashboardId} with its source report.
        slots:
          dashboardId: path.dashboardId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/dashboards/{dashboardId}/tiles/{tileId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one dashboard tile
      effect: read
      questions:
      - How do I get the embed URL for a single tile on a dashboard?
      - What configuration does one specific dashboard tile have?
      instructions:
      - text: Get tile {tileId} from dashboard {dashboardId}.
        slots:
          tileId: path.tileId
          dashboardId: path.dashboardId
      - text: Show the embed URL of tile {tileId} on dashboard {dashboardId}.
        slots:
          tileId: path.tileId
          dashboardId: path.dashboardId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{groupId}/dashboards'].get
  update:
    x-apievangelist-phrasing:
      intent: List dashboards in a workspace
      effect: read
      questions:
      - Which dashboards live in a shared workspace rather than My Workspace?
      - Can I list the dashboards of one team workspace?
      instructions:
      - text: List the dashboards in workspace {groupId}.
        slots:
          groupId: path.groupId
      - text: Show all dashboards inside the {groupId} workspace.
        slots:
          groupId: path.groupId
      method: generated
      generated: '2026-10-01'