TextQL · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for TextQL Tableau Service API

14 actions 14 updates phrasing extends openapi/textql-tableauservice-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 14

$.info
$.paths['/textql.rpc.public.tableau.TableauService/GenerateEmbedToken'].post
$.paths['/textql.rpc.public.tableau.TableauService/GetCollectionThumbnail'].post
$.paths['/textql.rpc.public.tableau.TableauService/GetConnectedAppStatus'].post
$.paths['/textql.rpc.public.tableau.TableauService/GetStarredTableauItems'].post
$.paths['/textql.rpc.public.tableau.TableauService/ListTableauDatasources'].post
$.paths['/textql.rpc.public.tableau.TableauService/ListTableauProjects'].post
$.paths['/textql.rpc.public.tableau.TableauService/ListTableauViews'].post
$.paths['/textql.rpc.public.tableau.TableauService/ListTableauWorkbooks'].post
$.paths['/textql.rpc.public.tableau.TableauService/RefreshTableauCollection'].post
$.paths['/textql.rpc.public.tableau.TableauService/ResetConnectedApp'].post
$.paths['/textql.rpc.public.tableau.TableauService/StarTableauItem'].post
$.paths['/textql.rpc.public.tableau.TableauService/TestTableauConnection'].post
$.paths['/textql.rpc.public.tableau.TableauService/UnstarTableauItem'].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 Tableau Service API
  version: 1.0.0
extends: openapi/textql-tableauservice-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: 13
- target: $.paths['/textql.rpc.public.tableau.TableauService/GenerateEmbedToken'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate a token to embed a Tableau view
      effect: write
      questions:
      - How do I embed a Tableau view inside TextQL?
      - Can I get a signed JWT for embedding one specific view?
      instructions:
      - text: Generate an embed token for Tableau view {view_id} on connector {connector_id}.
        slots:
          view_id: requestBody.viewId
          connector_id: requestBody.connectorId
      - text: Create a JWT so I can embed view {view_id}.
        slots:
          view_id: requestBody.viewId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.tableau.TableauService/GetCollectionThumbnail'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a Tableau collection's thumbnail
      effect: read
      questions:
      - Can I show a preview image for a Tableau collection?
      - Where does a collection's thumbnail come from?
      instructions:
      - text: Get the thumbnail for Tableau collection {dataset_id}.
        slots:
          dataset_id: requestBody.datasetId
      - text: Fetch the first-view preview image of collection {dataset_id}.
        slots:
          dataset_id: requestBody.datasetId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.tableau.TableauService/GetConnectedAppStatus'].post
  update:
    x-apievangelist-phrasing:
      intent: Check a Tableau connected app's status
      effect: read
      questions:
      - Is the Tableau connected app set up correctly for my connector?
      - Why might Tableau embedding be failing on a connector?
      instructions:
      - text: Check the connected app status for Tableau connector {connector_id}.
        slots:
          connector_id: requestBody.connectorId
      - text: Tell me whether connector {connector_id} has a working Tableau connected app.
        slots:
          connector_id: requestBody.connectorId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.tableau.TableauService/GetStarredTableauItems'].post
  update:
    x-apievangelist-phrasing:
      intent: List my starred Tableau items
      effect: read
      questions:
      - Which Tableau workbooks and views have I starred?
      - Can I see my favorite Tableau items for a connector?
      instructions:
      - text: List my starred Tableau items on connector {connector_id}.
        slots:
          connector_id: requestBody.connectorId
      - text: Show the Tableau favorites I've starred through {connector_id}.
        slots:
          connector_id: requestBody.connectorId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.tableau.TableauService/ListTableauDatasources'].post
  update:
    x-apievangelist-phrasing:
      intent: List Tableau datasources
      effect: read
      questions:
      - What published datasources are on my Tableau site?
      - Can TextQL see the Tableau datasources behind a connector?
      instructions:
      - text: List Tableau datasources on connector {connector_id}.
        slots:
          connector_id: requestBody.connectorId
      - text: Show every published datasource available through {connector_id}.
        slots:
          connector_id: requestBody.connectorId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.tableau.TableauService/ListTableauProjects'].post
  update:
    x-apievangelist-phrasing:
      intent: List Tableau projects
      effect: read
      questions:
      - Which Tableau projects can I browse?
      - What projects exist on the Tableau site behind my connector?
      instructions:
      - text: List Tableau projects on connector {connector_id}.
        slots:
          connector_id: requestBody.connectorId
      - text: Browse the project folders of Tableau connector {connector_id}.
        slots:
          connector_id: requestBody.connectorId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.tableau.TableauService/ListTableauViews'].post
  update:
    x-apievangelist-phrasing:
      intent: List views in a Tableau workbook
      effect: read
      questions:
      - What sheets and views are inside a Tableau workbook?
      - Can I list views by workbook name instead of ID?
      instructions:
      - text: List views in Tableau workbook {workbook_id} on connector {connector_id}.
        slots:
          workbook_id: requestBody.workbookId
          connector_id: requestBody.connectorId
      - text: Show the views of the workbook named {workbook_name}.
        slots:
          workbook_name: requestBody.workbookName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.tableau.TableauService/ListTableauWorkbooks'].post
  update:
    x-apievangelist-phrasing:
      intent: List Tableau workbooks in a project
      effect: read
      questions:
      - Which Tableau workbooks are in a given project?
      - Can I find workbooks by project name?
      instructions:
      - text: List Tableau workbooks in project {project_id} on connector {connector_id}.
        slots:
          project_id: requestBody.projectId
          connector_id: requestBody.connectorId
      - text: Show workbooks in the Tableau project called {project_name}.
        slots:
          project_name: requestBody.projectName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.tableau.TableauService/RefreshTableauCollection'].post
  update:
    x-apievangelist-phrasing:
      intent: Refresh a Tableau collection
      effect: write
      questions:
      - How do I pull the latest Tableau content into a collection?
      - Can I resync a Tableau collection after changes on the server?
      instructions:
      - text: Refresh Tableau collection {dataset_id}.
        slots:
          dataset_id: requestBody.datasetId
      - text: Resync collection {dataset_id} with the Tableau server.
        slots:
          dataset_id: requestBody.datasetId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.tableau.TableauService/ResetConnectedApp'].post
  update:
    x-apievangelist-phrasing:
      intent: Reset a Tableau connected app
      effect: write
      questions:
      - Can I reset the Tableau connected app when embedding breaks?
      - What does resetting a connector's connected app do?
      instructions:
      - text: Reset the Tableau connected app on connector {connector_id}.
        slots:
          connector_id: requestBody.connectorId
      - text: Recreate the connected app setup for {connector_id}.
        slots:
          connector_id: requestBody.connectorId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.tableau.TableauService/StarTableauItem'].post
  update:
    x-apievangelist-phrasing:
      intent: Star a Tableau item
      effect: write
      questions:
      - Can I star a Tableau workbook or view so it's easy to find?
      - Which kinds of Tableau items can be starred?
      instructions:
      - text: Star Tableau {item_type} {item_id} on connector {connector_id}.
        slots:
          item_type: requestBody.itemType
          item_id: requestBody.itemId
          connector_id: requestBody.connectorId
      - text: Add {item_name} to my starred Tableau items.
        slots:
          item_name: requestBody.itemName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.tableau.TableauService/TestTableauConnection'].post
  update:
    x-apievangelist-phrasing:
      intent: Test a Tableau connection
      effect: read
      questions:
      - How can I check my Tableau server URL and access token work?
      - Will a personal access token connect to a specific Tableau site?
      instructions:
      - text: Test the Tableau connection to {server_url} site {site_name}.
        slots:
          server_url: requestBody.serverUrl
          site_name: requestBody.siteName
      - text: Verify personal access token {pat_name} against {server_url}.
        slots:
          pat_name: requestBody.patName
          server_url: requestBody.serverUrl
      - text: Re-test Tableau connector {connector_id}.
        slots:
          connector_id: requestBody.connectorId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.tableau.TableauService/UnstarTableauItem'].post
  update:
    x-apievangelist-phrasing:
      intent: Unstar a Tableau item
      effect: write
      questions:
      - How do I remove a Tableau item from my starred list?
      - Can I unstar a view I starred earlier?
      instructions:
      - text: Unstar Tableau {item_type} {item_id} on connector {connector_id}.
        slots:
          item_type: requestBody.itemType
          item_id: requestBody.itemId
          connector_id: requestBody.connectorId
      - text: Take item {item_id} off my Tableau favorites.
        slots:
          item_id: requestBody.itemId
      method: generated
      generated: '2026-10-01'