# 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 Clusters (cmk/v2) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-clusters-cmk-v2-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['/cmk/v2/clusters'].get
  update:
    x-apievangelist-phrasing:
      intent: List Kafka clusters
      effect: read
      questions:
      - Which Kafka clusters exist in my Confluent Cloud environment?
      - Can I list only the Kafka clusters attached to a particular network?
      instructions:
      - text: List Kafka clusters in environment {environment}.
        slots:
          environment: query.environment
      - text: List Kafka clusters in {environment} on network {network}.
        slots:
          environment: query.environment
          network: query.spec.network
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cmk/v2/clusters'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Kafka cluster
      effect: write
      questions:
      - How do I provision a new Kafka cluster through the API?
      - Can I choose the cloud, region and cluster type when creating a Kafka cluster?
      instructions:
      - text: Create a Kafka cluster with spec {spec}.
        slots:
          spec: requestBody.spec
      - text: Provision a new Kafka cluster using {spec}.
        slots:
          spec: requestBody.spec
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cmk/v2/clusters/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Kafka cluster
      effect: read
      questions:
      - What is the bootstrap endpoint and status of one of my Kafka clusters?
      - Is my new Kafka cluster provisioned yet?
      instructions:
      - text: Show Kafka cluster {id} in environment {environment}.
        slots:
          environment: query.environment
          id: path.id
      - text: Check the provisioning status of Kafka cluster {id} in {environment}.
        slots:
          environment: query.environment
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cmk/v2/clusters/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Kafka cluster
      effect: destructive
      questions:
      - How do I tear down a Kafka cluster I no longer use?
      - Can I delete a Kafka cluster and everything in it?
      instructions:
      - text: Delete Kafka cluster {id} in environment {environment}.
        slots:
          environment: query.environment
          id: path.id
      - text: Tear down Kafka cluster {id} from {environment}.
        slots:
          environment: query.environment
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cmk/v2/clusters/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a Kafka cluster
      effect: write
      questions:
      - Can I rename a Kafka cluster or change its capacity after creation?
      - Is resizing a dedicated Kafka cluster done with an update?
      instructions:
      - text: Update Kafka cluster {id} with spec {spec}.
        slots:
          id: path.id
          spec: requestBody.spec
      - text: Resize or rename Kafka cluster {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'