Skip to content

Commit 87aa0cd

Browse files
Bill LeoutsakosBill Leoutsakos
authored andcommitted
fix(powerbi): generate docs entirely from source
1 parent 38d50c6 commit 87aa0cd

7 files changed

Lines changed: 13 additions & 30 deletions

File tree

‎apps/docs/content/docs/integrations/powerbi.mdx‎

Lines changed: 4 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -10,24 +10,9 @@ import { BlockInfoCard } from "@/components/ui/block-info-card"
1010
color="#FFFFFF"
1111
/>
1212

13-
{/* MANUAL-CONTENT-START:intro */}
14-
[Power BI](https://www.microsoft.com/en-us/power-platform/products/power-bi) is Microsoft's analytics platform. Use this block to list named workspaces, inspect reports and semantic models, run one DAX query, request a standard semantic-model refresh, and read refresh history.
15-
16-
Connect a home-tenant organizational account through the **Power BI** Microsoft connection. Existing Microsoft Graph connections cannot substitute for it. Self-hosted installations use the existing Microsoft client environment variables and register `/api/auth/oauth2/callback/microsoft-powerbi` as a Web redirect URI. This version supports delegated OAuth only, without Credential Groups or service principals.
17-
18-
**Execute DAX Query** requires the tenant's **Dataset Execute Queries REST API** setting, workspace access, and Read and Build permissions on the semantic model. Submit one DAX query that returns one table. The API limits each query to 100,000 rows or 1,000,000 values, 15 MB of returned data, and 120 query requests per minute per user. Dynamic column names are preserved. An HTTP 200 response can contain an error with partial rows; any reported query error fails the action. Connect the block's error port to handle its standard `error` output. Failed workflow outputs omit query fields, including partial rows, `errors`, and `incomplete`; successful queries expose the declared outputs. Direct tool responses retain available partial rows and typed errors, but those fields are unavailable to downstream workflow blocks after failure. See Microsoft's [Execute Queries documentation](https://learn.microsoft.com/en-us/rest/api/power-bi/datasets/execute-queries-in-group).
19-
20-
**Refresh Semantic Model** requests a standard refresh and returns acceptance immediately. Acceptance does not mean the refresh completed. Use **Get Refresh History** separately to inspect status; it requires write permission on the model. `Unknown` can mean a refresh is in progress or its completion state is unknown. Standard refresh is subject to capacity limits, including eight refresh requests per day on shared capacity. See Microsoft's [refresh documentation](https://learn.microsoft.com/en-us/rest/api/power-bi/datasets/refresh-dataset-in-group) and [refresh history documentation](https://learn.microsoft.com/en-us/rest/api/power-bi/datasets/get-refresh-history-in-group).
21-
22-
Read-only semantic models may return only their ID and name, and paginated reports may have no semantic-model ID. Missing optional fields are represented as `null`, so their absence does not imply a permission or feature capability.
23-
24-
Workspace listing supports a result limit, offset, and OData filter. Reports and semantic models return the provider's flat list; Sim does not invent pagination for them. Provider JSON readers are bounded to 20 MiB; workflow actions also use Sim's stricter 10 MiB inline tool-response budget. Keep DAX results small with summaries or `TOPN`. My Workspace, cross-tenant guest configuration, impersonation, enhanced refresh, report exports, dashboards, and triggers are outside this version.
25-
{/* MANUAL-CONTENT-END */}
26-
27-
2813
## Usage Instructions
2914

30-
Connect Power BI to your workflows with a delegated organizational Microsoft account. List accessible workspaces, reports, and semantic models; retrieve report and model details; execute one DAX query; request a standard semantic model refresh; and inspect refresh history. DAX queries require Read and Build permissions and the tenant Execute Queries setting. Refresh history requires model Write permission. Refresh requests return acceptance immediately; use a separate history operation to check their status.
15+
Connect a home-tenant organizational account through the Power BI Microsoft connection to list named workspaces, inspect reports and semantic models, execute DAX queries, request standard refreshes, and read refresh history. Microsoft Graph connections cannot substitute for this delegated OAuth connection. See the [self-hosted OAuth setup](/platform/self-hosting/integrations-oauth#microsoft) for app registration and the Power BI callback URI. Workspace listing supports a result limit, offset, and OData filter; reports and semantic models return flat lists. Read-only models may contain only their ID and name, and paginated reports may omit their semantic-model ID. Missing optional fields are null and do not establish permission or feature availability. Keep results small with summaries or TOPN: provider JSON reads are limited to 20 MiB, and workflow tool responses have a stricter 10 MiB inline budget. My Workspace, cross-tenant guest configuration, Credential Groups, service principals, impersonation, enhanced refresh, report exports, dashboards, and triggers are outside this version.
3116

3217

3318

@@ -132,7 +117,7 @@ Get semantic model metadata from a Power BI workspace.
132117

133118
### Power BI Execute DAX Query
134119

135-
Execute one DAX query against a semantic model and detect reported query errors.
120+
Execute one DAX query returning one table from a semantic model. Requires workspace access, Read and Build permissions, and the tenant Dataset Execute Queries REST API setting. Power BI limits each query to 100,000 rows or 1,000,000 values, 15 MB of data, and 120 requests per minute per user. Dynamic column names are preserved. Any reported query error fails the action, including errors returned with HTTP 200. Connect the block's error port to handle its standard error output. Failed workflow outputs omit query fields, including partial rows, errors, and incomplete; successful queries expose the declared outputs. Direct tool responses retain available partial rows and typed errors, but downstream workflow blocks cannot access them after failure. See the [Execute Queries documentation](https://learn.microsoft.com/en-us/rest/api/power-bi/datasets/execute-queries-in-group).
136121

137122
#### Input
138123

@@ -157,7 +142,7 @@ Execute one DAX query against a semantic model and detect reported query errors.
157142

158143
### Power BI Refresh Semantic Model
159144

160-
Request a standard asynchronous semantic model refresh; acceptance does not mean completion.
145+
Request a standard asynchronous semantic model refresh and return acceptance immediately. Acceptance does not mean completion; use Get Refresh History separately to inspect status. Shared capacity allows eight refresh requests per day, including scheduled refreshes. See the [refresh documentation](https://learn.microsoft.com/en-us/rest/api/power-bi/datasets/refresh-dataset-in-group).
161146

162147
#### Input
163148

@@ -177,7 +162,7 @@ Request a standard asynchronous semantic model refresh; acceptance does not mean
177162

178163
### Power BI Get Refresh History
179164

180-
Get recent semantic model refresh history; requires Write permission on the model.
165+
Get recent semantic model refresh history; requires Write permission on the model. Unknown can mean a refresh is in progress or its completion state is unknown. See the [refresh history documentation](https://learn.microsoft.com/en-us/rest/api/power-bi/datasets/get-refresh-history-in-group).
181166

182167
#### Input
183168

‎apps/sim/blocks/blocks/powerbi.ts‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,7 @@ export const PowerBIBlock: BlockConfig = {
2525
type: 'powerbi',
2626
name: 'Power BI',
2727
description: 'Query semantic models and manage reports and refreshes',
28-
longDescription:
29-
'Connect Power BI to your workflows with a delegated organizational Microsoft account. List accessible workspaces, reports, and semantic models; retrieve report and model details; execute one DAX query; request a standard semantic model refresh; and inspect refresh history. DAX queries require Read and Build permissions and the tenant Execute Queries setting. Refresh history requires model Write permission. Refresh requests return acceptance immediately; use a separate history operation to check their status.',
28+
longDescription: `Connect a home-tenant organizational account through the Power BI Microsoft connection to list named workspaces, inspect reports and semantic models, execute DAX queries, request standard refreshes, and read refresh history. Microsoft Graph connections cannot substitute for this delegated OAuth connection. See the [self-hosted OAuth setup](/platform/self-hosting/integrations-oauth#microsoft) for app registration and the Power BI callback URI. Workspace listing supports a result limit, offset, and OData filter; reports and semantic models return flat lists. Read-only models may contain only their ID and name, and paginated reports may omit their semantic-model ID. Missing optional fields are null and do not establish permission or feature availability. Keep results small with summaries or TOPN: provider JSON reads are limited to 20 MiB, and workflow tool responses have a stricter 10 MiB inline budget. My Workspace, cross-tenant guest configuration, Credential Groups, service principals, impersonation, enhanced refresh, report exports, dashboards, and triggers are outside this version.`,
3029
docsLink: 'https://docs.sim.ai/integrations/powerbi',
3130
category: 'tools',
3231
integrationType: IntegrationType.Analytics,

‎apps/sim/tools/generated/tool-metadata.ts‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎apps/sim/tools/powerbi/execute-query.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ export const powerbiExecuteQueryTool: ToolConfig<
2525
> = {
2626
id: 'powerbi_execute_query',
2727
name: 'Power BI Execute DAX Query',
28-
description: 'Execute one DAX query against a semantic model and detect reported query errors.',
28+
description: `Execute one DAX query returning one table from a semantic model. Requires workspace access, Read and Build permissions, and the tenant Dataset Execute Queries REST API setting. Power BI limits each query to 100,000 rows or 1,000,000 values, 15 MB of data, and 120 requests per minute per user. Dynamic column names are preserved. Any reported query error fails the action, including errors returned with HTTP 200. Connect the block's error port to handle its standard error output. Failed workflow outputs omit query fields, including partial rows, errors, and incomplete; successful queries expose the declared outputs. Direct tool responses retain available partial rows and typed errors, but downstream workflow blocks cannot access them after failure. See the [Execute Queries documentation](https://learn.microsoft.com/en-us/rest/api/power-bi/datasets/execute-queries-in-group).`,
2929
version: '1.0.0',
3030
errorExtractor: 'nested-error-object',
3131
oauth: { required: true, provider: 'microsoft-powerbi' },

‎apps/sim/tools/powerbi/get-refresh-history.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ export const powerbiGetRefreshHistoryTool: ToolConfig<
2222
> = {
2323
id: 'powerbi_get_refresh_history',
2424
name: 'Power BI Get Refresh History',
25-
description: 'Get recent semantic model refresh history; requires Write permission on the model.',
25+
description: `Get recent semantic model refresh history; requires Write permission on the model. Unknown can mean a refresh is in progress or its completion state is unknown. See the [refresh history documentation](https://learn.microsoft.com/en-us/rest/api/power-bi/datasets/get-refresh-history-in-group).`,
2626
version: '1.0.0',
2727
errorExtractor: 'nested-error-object',
2828
oauth: { required: true, provider: 'microsoft-powerbi' },

‎apps/sim/tools/powerbi/refresh-dataset.ts‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,7 @@ export const powerbiRefreshDatasetTool: ToolConfig<
1717
> = {
1818
id: 'powerbi_refresh_dataset',
1919
name: 'Power BI Refresh Semantic Model',
20-
description:
21-
'Request a standard asynchronous semantic model refresh; acceptance does not mean completion.',
20+
description: `Request a standard asynchronous semantic model refresh and return acceptance immediately. Acceptance does not mean completion; use Get Refresh History separately to inspect status. Shared capacity allows eight refresh requests per day, including scheduled refreshes. See the [refresh documentation](https://learn.microsoft.com/en-us/rest/api/power-bi/datasets/refresh-dataset-in-group).`,
2221
version: '1.0.0',
2322
errorExtractor: 'nested-error-object',
2423
oauth: { required: true, provider: 'microsoft-powerbi' },

‎packages/deployment-config/src/integrations.json‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18462,7 +18462,7 @@
1846218462
"slug": "power-bi",
1846318463
"name": "Power BI",
1846418464
"description": "Query semantic models and manage reports and refreshes",
18465-
"longDescription": "Connect Power BI to your workflows with a delegated organizational Microsoft account. List accessible workspaces, reports, and semantic models; retrieve report and model details; execute one DAX query; request a standard semantic model refresh; and inspect refresh history. DAX queries require Read and Build permissions and the tenant Execute Queries setting. Refresh history requires model Write permission. Refresh requests return acceptance immediately; use a separate history operation to check their status.",
18465+
"longDescription": "Connect a home-tenant organizational account through the Power BI Microsoft connection to list named workspaces, inspect reports and semantic models, execute DAX queries, request standard refreshes, and read refresh history. Microsoft Graph connections cannot substitute for this delegated OAuth connection. See the [self-hosted OAuth setup](/platform/self-hosting/integrations-oauth#microsoft) for app registration and the Power BI callback URI. Workspace listing supports a result limit, offset, and OData filter; reports and semantic models return flat lists. Read-only models may contain only their ID and name, and paginated reports may omit their semantic-model ID. Missing optional fields are null and do not establish permission or feature availability. Keep results small with summaries or TOPN: provider JSON reads are limited to 20 MiB, and workflow tool responses have a stricter 10 MiB inline budget. My Workspace, cross-tenant guest configuration, Credential Groups, service principals, impersonation, enhanced refresh, report exports, dashboards, and triggers are outside this version.",
1846618466
"bgColor": "#FFFFFF",
1846718467
"iconName": "PowerBIIcon",
1846818468
"docsUrl": "https://docs.sim.ai/integrations/powerbi",
@@ -18489,15 +18489,15 @@
1848918489
},
1849018490
{
1849118491
"name": "Execute DAX Query",
18492-
"description": "Execute one DAX query against a semantic model and detect reported query errors."
18492+
"description": ""
1849318493
},
1849418494
{
1849518495
"name": "Refresh Semantic Model",
18496-
"description": "Request a standard asynchronous semantic model refresh; acceptance does not mean completion."
18496+
"description": "Request a standard asynchronous semantic model refresh and return acceptance immediately. Acceptance does not mean completion; use Get Refresh History separately to inspect status. Shared capacity allows eight refresh requests per day, including scheduled refreshes. See the [refresh documentation](https://learn.microsoft.com/en-us/rest/api/power-bi/datasets/refresh-dataset-in-group)."
1849718497
},
1849818498
{
1849918499
"name": "Get Refresh History",
18500-
"description": "Get recent semantic model refresh history; requires Write permission on the model."
18500+
"description": "Get recent semantic model refresh history; requires Write permission on the model. Unknown can mean a refresh is in progress or its completion state is unknown. See the [refresh history documentation](https://learn.microsoft.com/en-us/rest/api/power-bi/datasets/get-refresh-history-in-group)."
1850118501
}
1850218502
],
1850318503
"operationCount": 8,

0 commit comments

Comments
 (0)