# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for CData Connect AI REST API Embedded Connection API
  version: 1.0.0
extends: openapi/cdata-connection-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/poweredby/connection/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Start the add-connection flow for a customer
      effect: write
      questions:
      - How do I send a customer to connect their Salesforce or Snowflake data through Connect AI Embed?
      - Can I skip the data source picker and take the user straight to one connector's form?
      - What URL do I redirect my user to so they can add a new data connection?
      instructions:
      - text: Get an add-connection link for {dataSource} that returns the user to {redirectURL}.
        slots:
          dataSource: requestBody.dataSource
          redirectURL: requestBody.redirectURL
      - text: Start a new connection flow with external Id {externalId}, sending the user back to {redirectURL} when done.
        slots:
          externalId: requestBody.externalId
          redirectURL: requestBody.redirectURL
      - text: 'Create a new-connection link suggesting the name {name} (user can edit: {editableName}), returning to {redirectURL}.'
        slots:
          name: requestBody.name
          editableName: requestBody.editableName
          redirectURL: requestBody.redirectURL
      method: generated
      generated: '2026-09-26'
- target: $.paths['/poweredby/connection/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List a sub-account's data connections
      effect: read
      questions:
      - Which data connections has this sub-account already set up?
      - Can I find a connection by the external Id I assigned it after a redirect failed?
      - How do I find the MCP URL for each of a customer's connections?
      instructions:
      - text: List all connections for this sub-account.
      - text: Show the connections whose data source is {driver}.
        slots:
          driver: query.driver
      - text: Find the connection with external Id {externalId}.
        slots:
          externalId: query.externalId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/poweredby/sources/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List the data sources Connect AI Embed supports
      effect: read
      questions:
      - What data sources and connectors does Connect AI Embed support?
      - Is a particular SaaS app available as a connector my customers can pick?
      instructions:
      - text: List every supported data source connector.
      - text: Show me the catalog of connector types customers can choose from.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/poweredby/connection/edit/{connectionId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a link for a user to edit an existing connection
      effect: write
      questions:
      - How do I let a customer fix the credentials on a connection they already created?
      - Can I reopen an existing connection's settings form for the end user?
      instructions:
      - text: Get an edit link for connection {connectionId} that returns the user to {redirectURL}.
        slots:
          connectionId: path.connectionId
          redirectURL: requestBody.redirectURL
      - text: 'Open the edit form for existing connection {connectionId} with name {name} (user can edit: {editableName}), returning to {redirectURL}.'
        slots:
          connectionId: path.connectionId
          name: requestBody.name
          editableName: requestBody.editableName
          redirectURL: requestBody.redirectURL
      method: generated
      generated: '2026-09-26'
- target: $.paths['/poweredby/connection/delete/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a sub-account's connection
      effect: destructive
      questions:
      - How do I permanently remove a data connection a customer no longer uses?
      - Can I delete one connection without deleting the whole sub-account?
      instructions:
      - text: Delete connection {id}.
        slots:
          id: path.id
      - text: Remove the customer's data connection {id} entirely.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/poweredby/{connectionId}/metadata'].delete
  update:
    x-apievangelist-phrasing:
      intent: Clear a connection's metadata cache
      effect: destructive
      questions:
      - A connection is loading slowly or showing stale tables, can I reset its metadata cache?
      - How do I force a connection to refresh its cached schema metadata?
      instructions:
      - text: Clear the metadata cache for connection {connectionId}.
        slots:
          connectionId: path.connectionId
      - text: Flush the cached schema metadata on {connectionId} to fix loading issues.
        slots:
          connectionId: path.connectionId
      method: generated
      generated: '2026-09-26'