API Evangelist conversational phrasing for Confluent Cloud Configs (v3) API

# 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 Configs (v3) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-configs-v3-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: 17
- target: $.paths['/kafka/v3/clusters/{cluster_id}/broker-configs'].get
  update:
    x-apievangelist-phrasing:
      intent: List a cluster's dynamic broker configs
      effect: read
      questions:
      - Which broker settings have been dynamically overridden on my Kafka cluster?
      - Can I see all cluster-wide dynamic broker configuration in Confluent Cloud?
      instructions:
      - text: List the dynamic broker configs on cluster {cluster_id}.
        slots:
          cluster_id: path.cluster_id
      - text: Show every cluster-wide broker override set on Kafka cluster {cluster_id}.
        slots:
          cluster_id: path.cluster_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka/v3/clusters/{cluster_id}/broker-configs:alter'].post
  update:
    x-apievangelist-phrasing:
      intent: Change several broker configs at once
      effect: write
      questions:
      - How do I update multiple cluster-wide broker settings in one request?
      - Can I dry-run a batch of broker config changes before applying them?
      instructions:
      - text: Apply this batch of broker config changes {data} to cluster {cluster_id}.
        slots:
          data: requestBody.data
          cluster_id: path.cluster_id
      - text: Validate only, without applying, the broker config batch {data} on cluster {cluster_id}.
        slots:
          data: requestBody.data
          cluster_id: path.cluster_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka/v3/clusters/{cluster_id}/broker-configs/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one dynamic broker config
      effect: read
      questions:
      - What is the current value of a specific broker setting on my cluster?
      - Is a particular broker config overridden cluster-wide or at its default?
      instructions:
      - text: Get broker config {name} on cluster {cluster_id}.
        slots:
          name: path.name
          cluster_id: path.cluster_id
      - text: Show me the dynamic broker setting {name} for Kafka cluster {cluster_id}.
        slots:
          name: path.name
          cluster_id: path.cluster_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka/v3/clusters/{cluster_id}/broker-configs/{name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a single broker config value
      effect: write
      questions:
      - How do I change just one cluster-wide broker setting?
      - Can I set a single dynamic broker config to a new value?
      instructions:
      - text: Set broker config {name} to {value} on cluster {cluster_id}.
        slots:
          name: path.name
          value: requestBody.value
          cluster_id: path.cluster_id
      - text: Update the dynamic broker setting {name} on Kafka cluster {cluster_id}.
        slots:
          name: path.name
          cluster_id: path.cluster_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka/v3/clusters/{cluster_id}/broker-configs/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Reset a broker config to its default
      effect: destructive
      questions:
      - How do I put a broker setting back to its default value?
      - Can I remove a cluster-wide dynamic broker override?
      instructions:
      - text: Reset broker config {name} to default on cluster {cluster_id}.
        slots:
          name: path.name
          cluster_id: path.cluster_id
      - text: Remove the dynamic broker override {name} from Kafka cluster {cluster_id}.
        slots:
          name: path.name
          cluster_id: path.cluster_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka/v3/clusters/{cluster_id}/topics/{topic_name}/configs'].get
  update:
    x-apievangelist-phrasing:
      intent: List a topic's configs
      effect: read
      questions:
      - What configuration settings does one of my Kafka topics have?
      - Where can I see retention and cleanup settings for a single topic?
      instructions:
      - text: List the configs for topic {topic_name} on cluster {cluster_id}.
        slots:
          cluster_id: path.cluster_id
          topic_name: path.topic_name
      - text: Show all configuration parameters of topic {topic_name} in cluster {cluster_id}.
        slots:
          cluster_id: path.cluster_id
          topic_name: path.topic_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka/v3/clusters/{cluster_id}/topics/{topic_name}/configs:alter'].post
  update:
    x-apievangelist-phrasing:
      intent: Change several topic configs at once
      effect: write
      questions:
      - How do I update multiple settings on a topic in one call?
      - Can I validate a batch of topic config changes without applying them?
      instructions:
      - text: Apply the config changes {data} to topic {topic_name} on cluster {cluster_id}.
        slots:
          data: requestBody.data
          cluster_id: path.cluster_id
          topic_name: path.topic_name
      - text: Dry-run the topic config batch {data} for topic {topic_name} on cluster {cluster_id}.
        slots:
          data: requestBody.data
          cluster_id: path.cluster_id
          topic_name: path.topic_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka/v3/clusters/{cluster_id}/topics/{topic_name}/configs/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one topic config value
      effect: read
      questions:
      - What is a single config value, like retention.ms, set to on my topic?
      - Is one topic setting using its default or an override?
      instructions:
      - text: Get config {name} for topic {topic_name} on cluster {cluster_id}.
        slots:
          name: path.name
          cluster_id: path.cluster_id
          topic_name: path.topic_name
      - text: Show the value of setting {name} on topic {topic_name} in cluster {cluster_id}.
        slots:
          name: path.name
          cluster_id: path.cluster_id
          topic_name: path.topic_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka/v3/clusters/{cluster_id}/topics/{topic_name}/configs/{name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a single topic config value
      effect: write
      questions:
      - How do I change the retention period on one Kafka topic?
      - Can I update just one config on a topic without touching the rest?
      instructions:
      - text: Set config {name} to {value} on topic {topic_name} in cluster {cluster_id}.
        slots:
          name: path.name
          value: requestBody.value
          cluster_id: path.cluster_id
          topic_name: path.topic_name
      - text: Change topic {topic_name} setting {name} on cluster {cluster_id}.
        slots:
          name: path.name
          cluster_id: path.cluster_id
          topic_name: path.topic_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka/v3/clusters/{cluster_id}/topics/{topic_name}/configs/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Reset a topic config to its default
      effect: destructive
      questions:
      - How do I revert a topic setting back to the default?
      - Can I clear an override on one topic config?
      instructions:
      - text: Reset config {name} on topic {topic_name} in cluster {cluster_id} to default.
        slots:
          name: path.name
          cluster_id: path.cluster_id
          topic_name: path.topic_name
      - text: Remove the {name} override from topic {topic_name} on cluster {cluster_id}.
        slots:
          name: path.name
          cluster_id: path.cluster_id
          topic_name: path.topic_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka/v3/clusters/{cluster_id}/topics/-/configs'].get
  update:
    x-apievangelist-phrasing:
      intent: List configs for every topic in a cluster
      effect: read
      questions:
      - Can I pull the configuration of all topics on a cluster in one request?
      - Which topics across my cluster have non-default settings?
      instructions:
      - text: List configs for all topics on cluster {cluster_id}.
        slots:
          cluster_id: path.cluster_id
      - text: Export every topic's configuration parameters from Kafka cluster {cluster_id}.
        slots:
          cluster_id: path.cluster_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka/v3/clusters/{cluster_id}/topics/{topic_name}/default-configs'].get
  update:
    x-apievangelist-phrasing:
      intent: Preview default configs for a new topic
      effect: read
      questions:
      - What default settings would a topic get if I created it now?
      - Which config values does a newly created topic inherit?
      instructions:
      - text: Show the default configs topic {topic_name} would get if newly created on cluster {cluster_id}.
        slots:
          cluster_id: path.cluster_id
          topic_name: path.topic_name
      - text: List new-topic default configuration for {topic_name} in cluster {cluster_id}.
        slots:
          cluster_id: path.cluster_id
          topic_name: path.topic_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka/v3/clusters/{cluster_id}/groups/{group_id}/configs'].get
  update:
    x-apievangelist-phrasing:
      intent: List a group's configs
      effect: read
      questions:
      - What configurations are set on a consumer, share or streams group?
      - Can I see all settings for one Kafka group?
      instructions:
      - text: List the configs of group {group_id} on cluster {cluster_id}.
        slots:
          cluster_id: path.cluster_id
          group_id: path.group_id
      - text: Show every configuration for Kafka group {group_id} in cluster {cluster_id}.
        slots:
          cluster_id: path.cluster_id
          group_id: path.group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka/v3/clusters/{cluster_id}/groups/{group_id}/configs/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one group config value
      effect: read
      questions:
      - What is one specific setting on my consumer group set to?
      - Can I read a single config for a share or streams group?
      instructions:
      - text: Get config {name} for group {group_id} on cluster {cluster_id}.
        slots:
          name: path.name
          cluster_id: path.cluster_id
          group_id: path.group_id
      - text: Show the value of group setting {name} for {group_id} in cluster {cluster_id}.
        slots:
          name: path.name
          cluster_id: path.cluster_id
          group_id: path.group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka/v3/clusters/{cluster_id}/groups/{group_id}/configs/{name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a single group config value
      effect: write
      questions:
      - How do I change one setting on a Kafka consumer group?
      - Can I override a single config for a streams group?
      instructions:
      - text: Set group config {name} to {value} for group {group_id} on cluster {cluster_id}.
        slots:
          name: path.name
          value: requestBody.value
          cluster_id: path.cluster_id
          group_id: path.group_id
      - text: Override setting {name} with {value} on Kafka group {group_id} in cluster {cluster_id}.
        slots:
          name: path.name
          value: requestBody.value
          cluster_id: path.cluster_id
          group_id: path.group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka/v3/clusters/{cluster_id}/groups/{group_id}/configs/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a group config override
      effect: destructive
      questions:
      - How do I drop a config override so a group falls back to the default?
      - What happens when I delete a dynamic config on a consumer group?
      instructions:
      - text: Delete the {name} override on group {group_id} in cluster {cluster_id}.
        slots:
          name: path.name
          cluster_id: path.cluster_id
          group_id: path.group_id
      - text: Revert group {group_id} setting {name} to the default on cluster {cluster_id}.
        slots:
          name: path.name
          cluster_id: path.cluster_id
          group_id: path.group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka/v3/clusters/{cluster_id}/groups/{group_id}/configs:alter'].post
  update:
    x-apievangelist-phrasing:
      intent: Change several group configs at once
      effect: write
      questions:
      - Can I alter several settings on a consumer group in a single request?
      - Is there a validate-only mode for batch group config changes?
      instructions:
      - text: Apply the config batch {data} to group {group_id} on cluster {cluster_id}.
        slots:
          data: requestBody.data
          cluster_id: path.cluster_id
          group_id: path.group_id
      - text: Validate without applying the group config batch {data} for {group_id} in cluster {cluster_id}.
        slots:
          data: requestBody.data
          cluster_id: path.cluster_id
          group_id: path.group_id
      method: generated
      generated: '2026-09-26'