# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for airbyte-api Public Connections API
  version: 1.0.0
extends: openapi/airbyte-public-connections-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: 5
- target: $.paths['/connections'].get
  update:
    x-apievangelist-phrasing:
      intent: List connections
      effect: read
      questions:
      - How do I list all the connections in my workspaces?
      - Can I filter my connections by tag?
      - Is there a way to include deleted connections in the list?
      instructions:
      - text: List connections in workspace {workspaceIds}.
        slots:
          workspaceIds: query.workspaceIds
      - text: List connections tagged {tagIds}.
        slots:
          tagIds: query.tagIds
      - text: List all my connections, including deleted ones.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connections'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a connection between a source and destination
      effect: write
      questions:
      - How do I connect a source to a destination so data starts syncing?
      - Can I set a sync schedule and stream prefix when I first create a connection?
      - What happens to syncs on a non-breaking schema change for a new connection?
      instructions:
      - text: Create a connection from source {sourceId} to destination {destinationId}.
        slots:
          sourceId: requestBody.sourceId
          destinationId: requestBody.destinationId
      - text: Create a connection named {name} syncing source {sourceId} into destination {destinationId} with prefix {prefix}.
        slots:
          name: requestBody.name
          sourceId: requestBody.sourceId
          destinationId: requestBody.destinationId
          prefix: requestBody.prefix
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connections/{connectionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a connection's details
      effect: read
      questions:
      - How do I see the configuration and schedule of one connection?
      - Which source and destination does a given connection use?
      instructions:
      - text: Get connection {connectionId}.
        slots:
          connectionId: path.connectionId
      - text: Show the schedule and stream settings of connection {connectionId}.
        slots:
          connectionId: path.connectionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connections/{connectionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a connection
      effect: destructive
      questions:
      - How do I delete a connection I don't need anymore?
      - Can I remove a connection without deleting its source and destination?
      instructions:
      - text: Delete connection {connectionId}.
        slots:
          connectionId: path.connectionId
      - text: Remove the connection {connectionId} permanently.
        slots:
          connectionId: path.connectionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connections/{connectionId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an existing connection
      effect: write
      questions:
      - How do I change the sync schedule of a connection that already exists?
      - Can I pause an existing connection by changing its status?
      - Is it possible to rename a connection or change its stream prefix later?
      instructions:
      - text: Change the schedule of connection {connectionId} to {schedule}.
        slots:
          connectionId: path.connectionId
          schedule: requestBody.schedule
      - text: Set the status of connection {connectionId} to {status}.
        slots:
          connectionId: path.connectionId
          status: requestBody.status
      - text: Rename existing connection {connectionId} to {name}.
        slots:
          connectionId: path.connectionId
          name: requestBody.name
      method: generated
      generated: '2026-09-26'