# 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-the-data-streaming-platform-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 in a Kafka cluster
      effect: read
      questions:
      - Which managed connectors are active on my Kafka cluster?
      - Can I get just the names of the connectors running in an environment?
      instructions:
      - text: List the connector names on cluster {cluster} in environment {environment}.
        slots:
          cluster: path.kafka_cluster_id
          environment: path.environment_id
      - text: Show me which connectors are active in {cluster}.
        slots:
          cluster: 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 fully managed connector on Confluent Cloud?
      - Can I set starting offsets when creating a new connector?
      instructions:
      - text: Create a connector named {name} on cluster {cluster} in {environment} with config {config}.
        slots:
          name: requestBody.name
          cluster: path.kafka_cluster_id
          environment: path.environment_id
          config: requestBody.config
      - text: Launch new connector {name} in {cluster} starting from offsets {offsets}.
        slots:
          name: requestBody.name
          cluster: 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 get the status and config of every connector in one call?
      - Which of my connectors are failing, without reading each one separately?
      instructions:
      - text: List all connectors on {cluster} in {environment} expanded with {expand}.
        slots:
          cluster: path.kafka_cluster_id
          environment: path.environment_id
          expand: query.expand
      - text: Show the status and info of every connector in cluster {cluster}.
        slots:
          cluster: path.kafka_cluster_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 settings is a connector currently running with?
      - Where can I see the config properties of one connector?
      instructions:
      - text: Get the configuration of connector {connector} on cluster {cluster} in {environment}.
        slots:
          connector: path.connector_name
          cluster: path.kafka_cluster_id
          environment: path.environment_id
      - text: Show me the config map for {connector}.
        slots:
          connector: path.connector_name
      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 a connector's configuration in place without deleting it?
      - Which fields are required when putting a connector config, like the connector class and Kafka API key?
      instructions:
      - text: Set the config of connector {connector} on {cluster} in {environment} to class {class}.
        slots:
          connector: path.connector_name
          cluster: path.kafka_cluster_id
          environment: path.environment_id
          class: requestBody.connector.class
      - text: Update {connector} to authenticate with Kafka API key {api_key} and secret {api_secret}.
        slots:
          connector: path.connector_name
          api_key: requestBody.kafka.api.key
          api_secret: requestBody.kafka.api.secret
      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: Read a connector's details
      effect: read
      questions:
      - What type and tasks does a specific connector have?
      - Can I look up one connector's information by name?
      instructions:
      - text: Get connector {connector} on cluster {cluster} in {environment}.
        slots:
          connector: path.connector_name
          cluster: path.kafka_cluster_id
          environment: path.environment_id
      - text: Show details about the {connector} connector.
        slots:
          connector: path.connector_name
      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:
      - What happens to running tasks when I delete a connector?
      - Can I remove a connector and its configuration completely?
      instructions:
      - text: Delete connector {connector} from cluster {cluster} in {environment}.
        slots:
          connector: path.connector_name
          cluster: path.kafka_cluster_id
          environment: path.environment_id
      - text: Remove the {connector} connector and halt its tasks.
        slots:
          connector: path.connector_name
      method: generated
      generated: '2026-09-26'