# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Lytics Connections API
  version: 1.0.0
extends: openapi/lytics-connections-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 8
- target: $.paths['/connection'].get
  update:
    x-apievangelist-phrasing:
      intent: List data warehouse connections
      effect: read
      questions:
      - Which external data connections are set up on my account?
      - Can I see every Cloud Connect connection in one list?
      instructions:
      - text: List all my data connections.
      - text: Show the connections configured on account {account_id}.
        slots:
          account_id: query.account_id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/connection'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a connection to an external data source
      effect: write
      questions:
      - How do I connect my data warehouse so I can build Cloud Connect models?
      - What auth and provider do I need to set when creating a connection?
      instructions:
      - text: Create a connection labelled {label} to provider {provider_slug} using auth {auth_ids}.
        slots:
          label: requestBody.label
          provider_slug: requestBody.provider_slug
          auth_ids: requestBody.auth_ids
      - text: Set up a new connection {label} with connection config {connection_config_slug}.
        slots:
          label: requestBody.label
          connection_config_slug: requestBody.connection_config_slug
      method: generated
      generated: '2026-10-02'
- target: $.paths['/connection/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one connection's details
      effect: read
      questions:
      - Can I look up the settings of a single connection by its id?
      - Which provider and auth does a particular connection use?
      instructions:
      - text: Show connection {id}.
        slots:
          id: path.id
      - text: Fetch the details of connection {id} on account {account_id}.
        slots:
          id: path.id
          account_id: query.account_id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/connection/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a connection's label or credentials
      effect: write
      questions:
      - Can I swap the auth credentials an existing connection uses?
      - Is it possible to rename a connection after creating it?
      instructions:
      - text: Rename connection {id} to {label}.
        slots:
          id: path.id
          label: requestBody.label
      - text: Point connection {id} at auth {auth_ids} instead.
        slots:
          id: path.id
          auth_ids: requestBody.auth_ids
      method: generated
      generated: '2026-10-02'
- target: $.paths['/connection/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a connection
      effect: destructive
      questions:
      - How do I remove a data connection I no longer use?
      - Can a connection be deleted permanently from my account?
      instructions:
      - text: Delete connection {id}.
        slots:
          id: path.id
      - text: Remove the data connection {id} from account {account_id}.
        slots:
          id: path.id
          account_id: query.account_id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/connection/{id}/scan'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a sample query on an external source
      effect: read
      questions:
      - Can I preview sample rows from my warehouse before building a Cloud Connect model?
      - What would a SQL query against my connected source return for a few members?
      instructions:
      - text: Run query {query} against connection {id} and return {limit} sample rows.
        slots:
          query: requestBody.query
          id: path.id
          limit: query.limit
      - text: Scan connection {id} with primary keys {primary_keys} to preview results.
        slots:
          id: path.id
          primary_keys: requestBody.primary_keys
      method: generated
      generated: '2026-10-02'
- target: $.paths['/connection/{id}/schema'].get
  update:
    x-apievangelist-phrasing:
      intent: List the tables on a connection
      effect: read
      questions:
      - Which tables can I see through a given connection?
      - What table names are available in my connected warehouse?
      instructions:
      - text: List the tables available on connection {id}.
        slots:
          id: path.id
      - text: Show every table name connection {id} exposes.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/connection/{id}/schema/{table}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the columns of a table on a connection
      effect: read
      questions:
      - What columns does a particular table in my warehouse have?
      - Can I inspect one table's schema through a connection?
      instructions:
      - text: Show the columns of table {table} on connection {id}.
        slots:
          table: path.table
          id: path.id
      - text: Describe the schema of {table} via connection {id}.
        slots:
          table: path.table
          id: path.id
      method: generated
      generated: '2026-10-02'