TextQL · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for TextQL Power BI Service API

11 actions 11 updates phrasing extends openapi/textql-powerbiservice-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for TextQL's API. It is a proposal applied on top of the contract, not a document TextQL publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 11

$.info
$.paths['/textql.rpc.public.powerbi.PowerBIService/ExportPowerBIReportImage'].post
$.paths['/textql.rpc.public.powerbi.PowerBIService/GeneratePowerBIEmbedToken'].post
$.paths['/textql.rpc.public.powerbi.PowerBIService/GetPowerBIDatasetPreview'].post
$.paths['/textql.rpc.public.powerbi.PowerBIService/GetSyncedPowerBIItems'].post
$.paths['/textql.rpc.public.powerbi.PowerBIService/ListPowerBIDatasets'].post
$.paths['/textql.rpc.public.powerbi.PowerBIService/ListPowerBIReports'].post
$.paths['/textql.rpc.public.powerbi.PowerBIService/ListPowerBIWorkspaces'].post
$.paths['/textql.rpc.public.powerbi.PowerBIService/SyncPowerBIItems'].post
$.paths['/textql.rpc.public.powerbi.PowerBIService/TestPowerBIConnection'].post
$.paths['/textql.rpc.public.powerbi.PowerBIService/UnsyncPowerBIItems'].post

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 TextQL Power BI Service API
  version: 1.0.0
extends: openapi/textql-powerbiservice-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: 10
- target: $.paths['/textql.rpc.public.powerbi.PowerBIService/ExportPowerBIReportImage'].post
  update:
    x-apievangelist-phrasing:
      intent: Export a Power BI report as an image
      effect: read
      questions:
      - Can I get a snapshot image of a Power BI report?
      - How do I render a Power BI report to a picture for sharing in chat?
      instructions:
      - text: Export Power BI report {reportId} in workspace {workspaceId} as an image.
        slots:
          reportId: requestBody.reportId
          workspaceId: requestBody.workspaceId
      - text: Render report {reportId} to an image through connector {connectorId}.
        slots:
          reportId: requestBody.reportId
          connectorId: requestBody.connectorId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.powerbi.PowerBIService/GeneratePowerBIEmbedToken'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate an embed token for a Power BI report
      effect: write
      questions:
      - How do I embed a Power BI report inside TextQL?
      - Does an embed token cover both the report and its dataset?
      instructions:
      - text: Generate an embed token for report {reportId} in workspace {workspaceId}.
        slots:
          reportId: requestBody.reportId
          workspaceId: requestBody.workspaceId
      - text: Create an embed token for report {reportId} and dataset {datasetId} via connector {connectorId}.
        slots:
          reportId: requestBody.reportId
          datasetId: requestBody.datasetId
          connectorId: requestBody.connectorId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.powerbi.PowerBIService/GetPowerBIDatasetPreview'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview rows from a Power BI dataset
      effect: read
      questions:
      - Can I see sample data from a Power BI dataset before syncing it?
      - How many rows will a dataset preview show?
      instructions:
      - text: Preview Power BI dataset {datasetId} in workspace {workspaceId}.
        slots:
          datasetId: requestBody.datasetId
          workspaceId: requestBody.workspaceId
      - text: Show the first {limit} rows of dataset {datasetName}.
        slots:
          limit: requestBody.limit
          datasetName: requestBody.datasetName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.powerbi.PowerBIService/GetSyncedPowerBIItems'].post
  update:
    x-apievangelist-phrasing:
      intent: List Power BI items already synced
      effect: read
      questions:
      - Which Power BI reports and datasets have I already synced into TextQL?
      - How do I check what a Power BI connector is currently syncing?
      instructions:
      - text: Show synced Power BI items for connector {connectorId}.
        slots:
          connectorId: requestBody.connectorId
      - text: List reports and datasets already synced by {connectorId}.
        slots:
          connectorId: requestBody.connectorId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.powerbi.PowerBIService/ListPowerBIDatasets'].post
  update:
    x-apievangelist-phrasing:
      intent: List datasets in a Power BI workspace
      effect: read
      questions:
      - What datasets live in a Power BI workspace?
      - Can I browse the semantic models a connector can reach in one workspace?
      instructions:
      - text: List Power BI datasets in workspace {workspaceId}.
        slots:
          workspaceId: requestBody.workspaceId
      - text: Show datasets visible to connector {connectorId} in workspace {workspaceId}.
        slots:
          connectorId: requestBody.connectorId
          workspaceId: requestBody.workspaceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.powerbi.PowerBIService/ListPowerBIReports'].post
  update:
    x-apievangelist-phrasing:
      intent: List reports in a Power BI workspace
      effect: read
      questions:
      - Which Power BI reports are available in a workspace?
      - Can I list reports before choosing which ones to sync?
      instructions:
      - text: List Power BI reports in workspace {workspaceId}.
        slots:
          workspaceId: requestBody.workspaceId
      - text: Show reports connector {connectorId} can see in workspace {workspaceId}.
        slots:
          connectorId: requestBody.connectorId
          workspaceId: requestBody.workspaceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.powerbi.PowerBIService/ListPowerBIWorkspaces'].post
  update:
    x-apievangelist-phrasing:
      intent: List Power BI workspaces for a connector
      effect: read
      questions:
      - Which Power BI workspaces can my connector access?
      - How do I find the workspace ID to browse reports from?
      instructions:
      - text: List Power BI workspaces for connector {connectorId}.
        slots:
          connectorId: requestBody.connectorId
      - text: Show every workspace reachable through {connectorId}.
        slots:
          connectorId: requestBody.connectorId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.powerbi.PowerBIService/SyncPowerBIItems'].post
  update:
    x-apievangelist-phrasing:
      intent: Sync Power BI reports and datasets into TextQL
      effect: write
      questions:
      - How do I bring selected Power BI reports and datasets into TextQL?
      - Can I sync items from a workspace by name?
      instructions:
      - text: Sync reports {reports} from workspace {workspaceId} via connector {connectorId}.
        slots:
          reports: requestBody.reports
          workspaceId: requestBody.workspaceId
          connectorId: requestBody.connectorId
      - text: Sync datasets {datasets} from Power BI workspace {workspaceName}.
        slots:
          datasets: requestBody.datasets
          workspaceName: requestBody.workspaceName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.powerbi.PowerBIService/TestPowerBIConnection'].post
  update:
    x-apievangelist-phrasing:
      intent: Test Power BI connection credentials
      effect: read
      questions:
      - How do I check that my Power BI service principal credentials work?
      - Can I verify a tenant and client ID before saving the connector?
      instructions:
      - text: Test the Power BI connection for tenant {tenantId} with client {clientId}.
        slots:
          tenantId: requestBody.tenantId
          clientId: requestBody.clientId
      - text: Check connectivity for Power BI connector {connectorId}.
        slots:
          connectorId: requestBody.connectorId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.powerbi.PowerBIService/UnsyncPowerBIItems'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop syncing Power BI reports or datasets
      effect: destructive
      questions:
      - How do I remove a Power BI report from TextQL's synced items?
      - Can I unsync several datasets at once?
      instructions:
      - text: Unsync reports {reportIds} from connector {connectorId}.
        slots:
          reportIds: requestBody.reportIds
          connectorId: requestBody.connectorId
      - text: Stop syncing Power BI datasets {datasetIds}.
        slots:
          datasetIds: requestBody.datasetIds
      method: generated
      generated: '2026-10-01'