# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Confluent Cloud Connectors (connect/v1) API
  version: 1.0.0
extends: openapi/confluent-connectors-connect-v1-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: 7
- target: $.paths['/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors'].get
  update:
    x-apievangelist-phrasing:
      intent: List connector names on a cluster
      effect: read
      questions:
      - Which managed connectors are active on my Kafka cluster?
      - Can I get just the names of all running connectors in an environment?
      instructions:
      - text: List the connector names on cluster {kafka_cluster_id} in environment {environment_id}.
        slots:
          kafka_cluster_id: path.kafka_cluster_id
          environment_id: path.environment_id
      - text: Show just the active connector names in environment {environment_id}, cluster {kafka_cluster_id}.
        slots:
          environment_id: path.environment_id
          kafka_cluster_id: path.kafka_cluster_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a managed connector
      effect: write
      questions:
      - How do I create a new fully managed connector on Confluent Cloud?
      - Can I set starting offsets when I create a connector?
      instructions:
      - text: Create connector {name} on cluster {kafka_cluster_id} in environment {environment_id} with config {config}.
        slots:
          name: requestBody.name
          kafka_cluster_id: path.kafka_cluster_id
          environment_id: path.environment_id
          config: requestBody.config
      - text: Create connector {name} in {environment_id}/{kafka_cluster_id} starting from offsets {offsets}.
        slots:
          name: requestBody.name
          environment_id: path.environment_id
          kafka_cluster_id: path.kafka_cluster_id
          offsets: requestBody.offsets
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors?expand=info,status,id'].get
  update:
    x-apievangelist-phrasing:
      intent: List connectors with status and details
      effect: read
      questions:
      - Can I list connectors together with their status, info and IDs in one call?
      - Which of my connectors are failing, with status expanded for each?
      instructions:
      - text: List connectors in environment {environment_id}, cluster {kafka_cluster_id}, expanded with {expand}.
        slots:
          environment_id: path.environment_id
          kafka_cluster_id: path.kafka_cluster_id
          expand: query.expand
      - text: Show every connector with its status and info on cluster {kafka_cluster_id}, environment {environment_id}.
        slots:
          kafka_cluster_id: path.kafka_cluster_id
          environment_id: path.environment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/config'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a connector's configuration
      effect: read
      questions:
      - What configuration is a connector currently running with?
      - How do I see the config settings for one connector?
      instructions:
      - text: Get the configuration of connector {connector_name} in {environment_id}, cluster {kafka_cluster_id}.
        slots:
          connector_name: path.connector_name
          environment_id: path.environment_id
          kafka_cluster_id: path.kafka_cluster_id
      - text: Show connector {connector_name}'s config settings on cluster {kafka_cluster_id}, environment {environment_id}.
        slots:
          connector_name: path.connector_name
          kafka_cluster_id: path.kafka_cluster_id
          environment_id: path.environment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/config'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a connector's configuration
      effect: write
      questions:
      - Can I change the settings of an existing connector without deleting it?
      - Which fields are required when I put a connector config, like connector class and API key?
      instructions:
      - text: Update connector {connector_name} config in {environment_id}/{kafka_cluster_id} to use class {connector_class}.
        slots:
          connector_name: path.connector_name
          environment_id: path.environment_id
          kafka_cluster_id: path.kafka_cluster_id
          connector_class: requestBody.connector.class
      - text: Create or replace connector {connector_name} config on {kafka_cluster_id} in {environment_id} with API key {api_key}.
        slots:
          connector_name: path.connector_name
          kafka_cluster_id: path.kafka_cluster_id
          environment_id: path.environment_id
          api_key: requestBody.kafka.api.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get information about one connector
      effect: read
      questions:
      - What type and tasks does a specific connector have?
      - Can I look up a single connector's details by name?
      instructions:
      - text: Get connector {connector_name} in environment {environment_id}, cluster {kafka_cluster_id}.
        slots:
          connector_name: path.connector_name
          environment_id: path.environment_id
          kafka_cluster_id: path.kafka_cluster_id
      - text: Show info about connector {connector_name} on cluster {kafka_cluster_id} in {environment_id}.
        slots:
          connector_name: path.connector_name
          kafka_cluster_id: path.kafka_cluster_id
          environment_id: path.environment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a connector
      effect: destructive
      questions:
      - How do I delete a connector and stop all its tasks?
      - Does deleting a connector also remove its configuration?
      instructions:
      - text: Delete connector {connector_name} from cluster {kafka_cluster_id} in {environment_id}.
        slots:
          connector_name: path.connector_name
          kafka_cluster_id: path.kafka_cluster_id
          environment_id: path.environment_id
      - text: Remove connector {connector_name} and halt its tasks in {environment_id}/{kafka_cluster_id}.
        slots:
          connector_name: path.connector_name
          environment_id: path.environment_id
          kafka_cluster_id: path.kafka_cluster_id
      method: generated
      generated: '2026-09-26'