# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Data Connections API
  version: 1.0.0
extends: openapi/qliksense-data-connections-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: 9
- target: $.paths['/api/v1/data-connections'].get
  update:
    x-apievangelist-phrasing:
      intent: List data connections
      effect: read
      questions:
      - Which data connections can I see in my tenant?
      - Can I list only the connections I own or those in one space?
      instructions:
      - text: List my data connections.
      - text: List data connections in space {spaceId}, {limit} per page.
        slots:
          spaceId: query.spaceId
          limit: query.limit
      - text: List data connections matching filter {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/data-connections'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a data connection
      effect: write
      questions:
      - Can I create a new connection to a database or file source?
      - Is there an endpoint for adding a data connection programmatically?
      instructions:
      - text: Create a new data connection.
      - text: Add a data connection to my tenant.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/data-connections/{qID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a data connection
      effect: read
      questions:
      - Can I look up a single data connection by its ID or name?
      - Is it possible to see the parsed connection string of a connection?
      instructions:
      - text: Show data connection {qID}.
        slots:
          qID: path.qID
      - text: Get connection {qID} with parseConnection {parseConnection}.
        slots:
          qID: path.qID
          parseConnection: query.parseConnection
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/data-connections/{qID}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a data connection
      effect: write
      questions:
      - Can I rewrite a data connection's connect statement and credentials?
      - Which fields must I resend when replacing a whole data connection?
      instructions:
      - text: Replace connection {qID} with name {qName}, type {qType} and connect statement {qConnectStatement}.
        slots:
          qID: path.qID
          qName: requestBody.qName
          qType: requestBody.qType
          qConnectStatement: requestBody.qConnectStatement
      - text: Change the username of connection {qID} to {qUsername}.
        slots:
          qID: path.qID
          qUsername: requestBody.qUsername
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/data-connections/{qID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a data connection
      effect: destructive
      questions:
      - Can I remove a single data connection I no longer use?
      - Can I delete a connection by name rather than ID?
      instructions:
      - text: Delete data connection {qID}.
        slots:
          qID: path.qID
      - text: Remove connection {qID} from space {spaceId}.
        slots:
          qID: path.qID
          spaceId: query.spaceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/data-connections/{qID}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch a data connection
      effect: write
      questions:
      - Can I change just one property of a data connection?
      - Is a partial update of a connection supported?
      instructions:
      - text: Patch data connection {qID}.
        slots:
          qID: path.qID
      - text: Apply a partial update to connection {qID} of type {type}.
        slots:
          qID: path.qID
          type: query.type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/data-connections/actions/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete data connections
      effect: destructive
      questions:
      - Can an admin delete many data connections in a single request?
      - Is there a batch removal for old connections?
      instructions:
      - text: 'Delete these connections in bulk: {connections}.'
        slots:
          connections: requestBody.connections
      - text: As admin, remove the batch of connections {connections}.
        slots:
          connections: requestBody.connections
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/data-connections/actions/duplicate'].post
  update:
    x-apievangelist-phrasing:
      intent: Duplicate a data connection
      effect: write
      questions:
      - Can I clone an existing data connection?
      - Is it possible to copy a connection into another space with a new name?
      instructions:
      - text: Duplicate connection {id}.
        slots:
          id: requestBody.id
      - text: Clone connection {id} as {name} in space {spaceId}.
        slots:
          id: requestBody.id
          name: requestBody.name
          spaceId: requestBody.spaceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/data-connections/actions/update'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk update data connections
      effect: write
      questions:
      - Can an admin update many data connections at once?
      - Is there a batch update for connection settings?
      instructions:
      - text: 'Update these connections in bulk: {connections}.'
        slots:
          connections: requestBody.connections
      - text: As admin, apply batch changes to connections {connections}.
        slots:
          connections: requestBody.connections
      method: generated
      generated: '2026-10-01'