Power BI · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Power BI REST Gateways API

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

$.info

$.paths['/gateways'].get

$.paths['/gateways/{gatewayId}'].get

$.paths['/gateways/{gatewayId}/datasources'].get

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 Gateways API
  version: 1.0.0
extends: openapi/power-bi-gateways-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: 3
- target: $.paths['/gateways'].get
  update:
    x-apievangelist-phrasing:
      intent: List on-premises gateways I administer
      effect: read
      questions:
      - Which on-premises data gateways am I an admin of?
      - Where do I find a gateway's public key for encrypting credentials?
      instructions:
      - text: List the gateways I administer.
      - text: Show me all my on-premises gateways with their cluster info.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/gateways/{gatewayId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one on-premises gateway
      effect: read
      questions:
      - How can I look up the details of one specific gateway?
      - Can I fetch a single gateway by its ID?
      instructions:
      - text: Get gateway {gatewayId}.
        slots:
          gatewayId: path.gatewayId
      - text: Show the details of on-premises gateway {gatewayId}.
        slots:
          gatewayId: path.gatewayId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/gateways/{gatewayId}/datasources'].get
  update:
    x-apievangelist-phrasing:
      intent: List data sources on a gateway
      effect: read
      questions:
      - Which data sources are configured on a given gateway?
      - What connections does one on-premises gateway serve?
      instructions:
      - text: List the data sources on gateway {gatewayId}.
        slots:
          gatewayId: path.gatewayId
      - text: Show every data source configured on gateway {gatewayId}.
        slots:
          gatewayId: path.gatewayId
      method: generated
      generated: '2026-10-01'