Power BI · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Power BI REST Imports API

3 actions 3 updates phrasing extends openapi/power-bi-imports-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 3

$.info

$.paths['/groups/{groupId}/imports'].get

$.paths['/groups/{groupId}/imports'].post

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 Power BI REST Imports API
  version: 1.0.0
extends: openapi/power-bi-imports-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: 2
- target: $.paths['/groups/{groupId}/imports'].get
  update:
    x-apievangelist-phrasing:
      intent: List imports in a workspace
      effect: read
      questions:
      - Did my PBIX upload to a workspace finish importing?
      - What content has been imported into a workspace, and with what status?
      instructions:
      - text: List the imports in workspace {groupId}.
        slots:
          groupId: path.groupId
      - text: Show the status of recent imports into workspace {groupId}.
        slots:
          groupId: path.groupId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{groupId}/imports'].post
  update:
    x-apievangelist-phrasing:
      intent: Import a PBIX or Excel file into a workspace
      effect: write
      questions:
      - How do I upload a PBIX file into a workspace?
      - Can I import an Excel workbook and decide what happens if the dataset name already exists?
      instructions:
      - text: Import {file} into workspace {groupId} as dataset {datasetDisplayName}.
        slots:
          file: requestBody.file
          groupId: path.groupId
          datasetDisplayName: query.datasetDisplayName
      - text: Upload {file} to workspace {groupId} named {datasetDisplayName}, using {nameConflict} on a name clash.
        slots:
          file: requestBody.file
          groupId: path.groupId
          datasetDisplayName: query.datasetDisplayName
          nameConflict: query.nameConflict
      method: generated
      generated: '2026-10-01'