# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for TextQL v2 Connectors API
  version: 1.0.0
extends: openapi/textql-connectors-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: 8
- target: $.paths['/v2/connectors'].get
  update:
    x-apievangelist-phrasing:
      intent: List data connectors
      effect: read
      questions:
      - Which data connectors does my organization have?
      - What databases and warehouses are already connected to TextQL?
      instructions:
      - text: List all data connectors in my organization.
      - text: Show the connectors we've already set up.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/connectors'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a data connector
      effect: write
      questions:
      - How do I connect a new database?
      - Does creating a connector check that the database is reachable?
      - Can I set who has access to a connector when I create it?
      instructions:
      - text: Create a connector from config {config}.
        slots:
          config: requestBody.config
      - text: Create a connector with config {config} and access grants {access}.
        slots:
          config: requestBody.config
          access: requestBody.access
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/connectors/types'].get
  update:
    x-apievangelist-phrasing:
      intent: List supported connector types and fields
      effect: read
      questions:
      - What kinds of data sources can I connect?
      - Which fields does each connector type require in its config?
      instructions:
      - text: List every supported connector type and its required fields.
      - text: Show me the config fields I need for each connector type.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/connectors/test'].post
  update:
    x-apievangelist-phrasing:
      intent: Test a connector configuration
      effect: read
      questions:
      - Can I check a database connection works before saving the connector?
      - What does a failed connection test return?
      instructions:
      - text: Test connector config {config} without saving it.
        slots:
          config: requestBody.config
      - text: Test config {config} reusing the stored secrets of connector {connector_id}.
        slots:
          config: requestBody.config
          connector_id: requestBody.connector_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/connectors/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a data connector
      effect: destructive
      questions:
      - How do I remove a data connector?
      - Can example or system connectors be deleted?
      instructions:
      - text: Delete connector {id}.
        slots:
          id: path.id
      - text: Remove the data connector {id} from my organization.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/connectors/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a data connector
      effect: write
      questions:
      - Can I change a connector's settings without re-entering its password?
      - Is it possible to allow write or DDL SQL on a connector?
      instructions:
      - text: Update connector {id} with config {config}.
        slots:
          id: path.id
          config: requestBody.config
      - text: Set write SQL permission to {allow_sql_write_operations} on connector {id} using config {config}.
        slots:
          allow_sql_write_operations: requestBody.allow_sql_write_operations
          id: path.id
          config: requestBody.config
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/connectors/{id}/access'].get
  update:
    x-apievangelist-phrasing:
      intent: Get who can access a connector
      effect: read
      questions:
      - Who has access to a specific data connector?
      - Is this connector visible to the whole organization?
      instructions:
      - text: Show the access configuration for connector {id}.
        slots:
          id: path.id
      - text: List the member, role and group grants on connector {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/connectors/{id}/access'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a connector's access grants
      effect: write
      questions:
      - How do I share a connector with specific members, roles or groups?
      - Are grants I leave out of an access update revoked?
      instructions:
      - text: 'Make connector {id} public to the org: {is_public}.'
        slots:
          id: path.id
          is_public: requestBody.is_public
      - text: Replace connector {id}'s grants with {grants}, org-wide {is_public}.
        slots:
          id: path.id
          grants: requestBody.grants
          is_public: requestBody.is_public
      method: generated
      generated: '2026-10-01'