API Evangelist conversational phrasing for TextQL Connector Service API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for TextQL Connector Service API
  version: 1.0.0
extends: openapi/textql-connectorservice-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: 17
- target: $.paths['/textql.rpc.public.connector.ConnectorService/CreateConnector'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a data connector
      effect: write
      questions:
      - How do I connect TextQL to my data warehouse?
      - Can I allow SQL write operations when I set up a new connector?
      instructions:
      - text: Create a connector with config {config}.
        slots:
          config: requestBody.config
      - text: 'Add a new database connector using {config} and allow SQL writes: {allow_writes}.'
        slots:
          config: requestBody.config
          allow_writes: requestBody.allowSqlWriteOperations
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.connector.ConnectorService/DeleteConnector'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a data connector
      effect: destructive
      questions:
      - How do I remove a database connection I no longer use?
      - Can I delete a connector entirely?
      instructions:
      - text: Delete connector {connector}.
        slots:
          connector: requestBody.connectorId
      - text: Remove the data connection {connector}.
        slots:
          connector: requestBody.connectorId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.connector.ConnectorService/DuplicateConnector'].post
  update:
    x-apievangelist-phrasing:
      intent: Duplicate a data connector
      effect: write
      questions:
      - Can I clone an existing connector to make a variant of it?
      - How do I copy a connector's configuration into a new one?
      instructions:
      - text: Duplicate connector {connector}.
        slots:
          connector: requestBody.connectorId
      - text: Make a copy of the connection {connector}.
        slots:
          connector: requestBody.connectorId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.connector.ConnectorService/ExecuteQuery'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a SQL query on a connector
      effect: read
      questions:
      - How do I run raw SQL against one of my connected databases?
      - Can I cap how many rows a connector query returns?
      instructions:
      - text: Run {query} on connector {connector}.
        slots:
          query: requestBody.query
          connector: requestBody.connectorId
      - text: Execute SQL {query} against connector {connector} and return at most {limit} rows.
        slots:
          query: requestBody.query
          connector: requestBody.connectorId
          limit: requestBody.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.connector.ConnectorService/GetConnector'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a connector's details
      effect: read
      questions:
      - How do I look up the configuration of a single connector?
      - What settings does a given data connection have?
      instructions:
      - text: Get connector {connector}.
        slots:
          connector: requestBody.connectorId
      - text: Show the configuration of connection {connector}.
        slots:
          connector: requestBody.connectorId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.connector.ConnectorService/GetConnectorCellDurations'].post
  update:
    x-apievangelist-phrasing:
      intent: Get query cell durations for a connector
      effect: read
      questions:
      - Which queries against a connector have been the slowest lately?
      - How long are chat cells taking to run on a specific database?
      instructions:
      - text: Show cell durations for connector {connector} over the last {days} days.
        slots:
          connector: requestBody.connectorId
          days: requestBody.days
      - text: List the {limit} longest-running cells on connector {connector}.
        slots:
          limit: requestBody.limit
          connector: requestBody.connectorId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.connector.ConnectorService/GetConnectorChats'].post
  update:
    x-apievangelist-phrasing:
      intent: List chats that use a connector
      effect: read
      questions:
      - Which chats have queried a particular data connection?
      - Before I delete a connector, how do I see the conversations relying on it?
      instructions:
      - text: List chats that use connector {connector}.
        slots:
          connector: requestBody.connectorId
      - text: Show conversations that query connection {connector}.
        slots:
          connector: requestBody.connectorId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.connector.ConnectorService/GetConnectorDashboards'].post
  update:
    x-apievangelist-phrasing:
      intent: List dashboards built on a connector
      effect: read
      questions:
      - Which dashboards depend on a given connector?
      - What would break on the dashboard side if I changed this connection?
      instructions:
      - text: List dashboards that use connector {connector}.
        slots:
          connector: requestBody.connectorId
      - text: Show which dashboards are built on connection {connector}.
        slots:
          connector: requestBody.connectorId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.connector.ConnectorService/GetConnectorStats'].post
  update:
    x-apievangelist-phrasing:
      intent: Get usage stats across all connectors
      effect: read
      questions:
      - How heavily are all my connectors being used overall?
      - Can I get organization-wide connector statistics for a time window?
      instructions:
      - text: Show stats across all connectors for the last {days} days.
        slots:
          days: requestBody.days
      - text: Summarize organization-wide connector activity over {days} days.
        slots:
          days: requestBody.days
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.connector.ConnectorService/GetConnectorUsage'].post
  update:
    x-apievangelist-phrasing:
      intent: Get usage for one connector
      effect: read
      questions:
      - How much is a single connector being queried?
      - Is a specific data connection actually used anymore?
      instructions:
      - text: Show usage of connector {connector}.
        slots:
          connector: requestBody.connectorId
      - text: Get query activity on connection {connector} for the past {days} days.
        slots:
          connector: requestBody.connectorId
          days: requestBody.days
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.connector.ConnectorService/GetConnectors'].post
  update:
    x-apievangelist-phrasing:
      intent: List my data connectors
      effect: read
      questions:
      - Which data sources are connected to my TextQL organization?
      - What connectors can I query?
      instructions:
      - text: List all my connectors using Connect protocol version {protocol_version}.
        slots:
          protocol_version: header.Connect-Protocol-Version
      - text: Show every data connection with a {timeout_ms} ms timeout.
        slots:
          timeout_ms: header.Connect-Timeout-Ms
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.connector.ConnectorService/GetExampleQueries'].post
  update:
    x-apievangelist-phrasing:
      intent: Get example questions for connectors
      effect: read
      questions:
      - What example questions can I ask about my connected data?
      - Can I get suggested starter queries for a set of connectors?
      instructions:
      - text: Suggest example queries for connectors {contexts}.
        slots:
          contexts: requestBody.connectorContexts
      - text: Get starter questions filtered to feature {feature}.
        slots:
          feature: requestBody.featureFilter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.connector.ConnectorService/GetTablePreview'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview rows from a table
      effect: read
      questions:
      - Can I peek at the first few rows of a table in my warehouse?
      - How do I preview a table by database, schema and name?
      instructions:
      - text: Preview table {table} in schema {schema} on connector {connector}.
        slots:
          table: requestBody.tableName
          schema: requestBody.tableSchema
          connector: requestBody.connectorId
      - text: Show {limit} sample rows from {database}.{schema}.{table} on connector {connector}.
        slots:
          limit: requestBody.limit
          database: requestBody.tableDatabase
          schema: requestBody.tableSchema
          table: requestBody.tableName
          connector: requestBody.connectorId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.connector.ConnectorService/ListConnectorTables'].post
  update:
    x-apievangelist-phrasing:
      intent: List tables in a connector
      effect: read
      questions:
      - What tables can TextQL see through a given connection?
      - How do I browse the schema of a connected database?
      instructions:
      - text: List the tables in connector {connector}.
        slots:
          connector: requestBody.connectorId
      - text: Show the schema tables available on connection {connector}.
        slots:
          connector: requestBody.connectorId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.connector.ConnectorService/ListQueryTemplates'].post
  update:
    x-apievangelist-phrasing:
      intent: List query templates for a connector
      effect: read
      questions:
      - Which recurring query templates have been run on a connector?
      - Can I see the common query patterns used against a database recently?
      instructions:
      - text: List query templates for connector {connector}.
        slots:
          connector: requestBody.connectorId
      - text: Show query templates on connector {connector} from the last {days} days.
        slots:
          connector: requestBody.connectorId
          days: requestBody.days
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.connector.ConnectorService/TestConnector'].post
  update:
    x-apievangelist-phrasing:
      intent: Test a connector's connection
      effect: read
      questions:
      - How do I verify my database credentials work before saving a connector?
      - Can I re-test an existing connector to see if it still connects?
      instructions:
      - text: Test the connection settings {config}.
        slots:
          config: requestBody.config
      - text: Check that connector {connector} can still connect.
        slots:
          connector: requestBody.connectorId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.connector.ConnectorService/UpdateConnector'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a connector
      effect: write
      questions:
      - How do I change the credentials or settings of an existing connector?
      - Can I turn off SQL write operations on a connection I already set up?
      instructions:
      - text: Update connector {connector} with config {config}.
        slots:
          connector: requestBody.connectorId
          config: requestBody.config
      - text: Set allow SQL writes to {allow_writes} on connector {connector}.
        slots:
          allow_writes: requestBody.allowSqlWriteOperations
          connector: requestBody.connectorId
      method: generated
      generated: '2026-10-01'