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-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 overridden dynamically across my whole Kafka cluster?
      - Does the cluster-wide broker config list come back empty when nothing has been changed dynamically?
      instructions:
      - text: Show every dynamic broker config set on cluster {cluster_id}.
        slots:
          cluster_id: path.cluster_id
      - text: List the cluster-wide broker overrides for 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: Batch alter dynamic broker configs
      effect: write
      questions:
      - Can I change several cluster-wide broker settings in one request?
      - Is there a dry run to check 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 cluster-wide value of a single broker setting?
      - How do I read one named broker config on a Confluent Cloud Kafka cluster?
      instructions:
      - text: Get the broker config {name} on cluster {cluster_id}.
        slots:
          name: path.name
          cluster_id: path.cluster_id
      - text: Show me the dynamic broker value of {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: Update one dynamic broker config
      effect: write
      questions:
      - Can I set a single cluster-wide broker setting without sending a whole batch?
      - Where do I change just one broker config value for every broker in the cluster?
      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: Change the cluster-wide broker setting {name} on {cluster_id} to {value}.
        slots:
          name: path.name
          value: requestBody.value
          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 undo a dynamic broker override and go back to the default?
      - What happens to a broker setting when I delete its dynamic cluster-wide value?
      instructions:
      - text: Reset broker config {name} on cluster {cluster_id} to its default.
        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 particular topic have?
      - Can I see retention and cleanup settings for a single topic?
      instructions:
      - text: List the configs of topic {topic_name} on cluster {cluster_id}.
        slots:
          topic_name: path.topic_name
          cluster_id: path.cluster_id
      - text: Show all settings for topic {topic_name} in {cluster_id}.
        slots:
          topic_name: path.topic_name
          cluster_id: path.cluster_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka/v3/clusters/{cluster_id}/topics/{topic_name}/configs:alter'].post
  update:
    x-apievangelist-phrasing:
      intent: Batch alter a topic's configs
      effect: write
      questions:
      - Can I update or delete several settings on one topic at once?
      - Is there a validate-only mode for a batch of topic config changes?
      instructions:
      - text: Apply topic config changes {data} to topic {topic_name} on cluster {cluster_id}.
        slots:
          data: requestBody.data
          topic_name: path.topic_name
          cluster_id: path.cluster_id
      - text: Dry-run the topic config batch {data} for {topic_name} on {cluster_id} without applying it.
        slots:
          data: requestBody.data
          topic_name: path.topic_name
          cluster_id: path.cluster_id
      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 topic's current value for one specific setting like retention.ms?
      - How do I check a single named config on a Kafka topic?
      instructions:
      - text: Get config {name} for topic {topic_name} on cluster {cluster_id}.
        slots:
          name: path.name
          topic_name: path.topic_name
          cluster_id: path.cluster_id
      - text: What is {name} set to on topic {topic_name} in {cluster_id}.
        slots:
          name: path.name
          topic_name: path.topic_name
          cluster_id: path.cluster_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kafka/v3/clusters/{cluster_id}/topics/{topic_name}/configs/{name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update one topic config
      effect: write
      questions:
      - Can I change just one setting on a topic, like its retention time?
      - Does updating a topic config also let me change the partition count?
      instructions:
      - text: Set {name} to {value} on topic {topic_name} in cluster {cluster_id}.
        slots:
          name: path.name
          value: requestBody.value
          topic_name: path.topic_name
          cluster_id: path.cluster_id
      - text: Change topic {topic_name}'s {name} setting on {cluster_id} to {value}.
        slots:
          name: path.name
          value: requestBody.value
          topic_name: path.topic_name
          cluster_id: path.cluster_id
      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 default
      effect: destructive
      questions:
      - How do I put a topic setting back to its default value?
      - Can I clear a custom override on one topic without touching its other settings?
      instructions:
      - text: Reset config {name} on topic {topic_name} in cluster {cluster_id} to default.
        slots:
          name: path.name
          topic_name: path.topic_name
          cluster_id: path.cluster_id
      - text: Remove the {name} override from topic {topic_name} on {cluster_id}.
        slots:
          name: path.name
          topic_name: path.topic_name
          cluster_id: path.cluster_id
      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 settings of all topics in a cluster in one call?
      - Which topics across my cluster have non-default configuration?
      instructions:
      - text: Pull settings for all topics at once across cluster {cluster_id}.
        slots:
          cluster_id: path.cluster_id
      - text: Dump all topic settings across 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: List default configs for a new topic
      effect: read
      questions:
      - What settings would a topic get if I created it fresh right now?
      - Where can I see the defaults a newly created topic would inherit?
      instructions:
      - text: Show the default configs topic {topic_name} would get if newly created on {cluster_id}.
        slots:
          topic_name: path.topic_name
          cluster_id: path.cluster_id
      - text: List new-topic default settings for {topic_name} on cluster {cluster_id}.
        slots:
          topic_name: path.topic_name
          cluster_id: path.cluster_id
      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 configuration does a consumer, share or streams group have?
      - How do I see all settings for one group on my cluster?
      instructions:
      - text: List all configs for group {group_id} on cluster {cluster_id}.
        slots:
          group_id: path.group_id
          cluster_id: path.cluster_id
      - text: Show every setting of group {group_id} in {cluster_id}.
        slots:
          group_id: path.group_id
          cluster_id: path.cluster_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
      effect: read
      questions:
      - What value does a group have for one named setting like session timeout?
      - Can I check a single config on a share group or streams group?
      instructions:
      - text: Get config {name} for group {group_id} on cluster {cluster_id}.
        slots:
          name: path.name
          group_id: path.group_id
          cluster_id: path.cluster_id
      - text: What is {name} set to for group {group_id} in {cluster_id}.
        slots:
          name: path.name
          group_id: path.group_id
          cluster_id: path.cluster_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: Update one group config
      effect: write
      questions:
      - Can I override a single setting for one consumer group?
      - Which call changes just one config value on a streams or share group?
      instructions:
      - text: Set {name} to {value} for group {group_id} on cluster {cluster_id}.
        slots:
          name: path.name
          value: requestBody.value
          group_id: path.group_id
          cluster_id: path.cluster_id
      - text: Change group {group_id}'s {name} on {cluster_id} to {value}.
        slots:
          name: path.name
          value: requestBody.value
          group_id: path.group_id
          cluster_id: path.cluster_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:
      - What happens when I delete a group's config override?
      - How do I make a group fall back to the default for one setting?
      instructions:
      - text: Delete the {name} override on group {group_id} in cluster {cluster_id}.
        slots:
          name: path.name
          group_id: path.group_id
          cluster_id: path.cluster_id
      - text: Revert group {group_id} on {cluster_id} to the default {name}.
        slots:
          name: path.name
          group_id: path.group_id
          cluster_id: path.cluster_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: Batch alter a group's configs
      effect: write
      questions:
      - Can I change several settings on one consumer group in a single request?
      - Is it possible to validate a batch of group config changes without applying them?
      instructions:
      - text: Apply group config changes {data} to group {group_id} on cluster {cluster_id}.
        slots:
          data: requestBody.data
          group_id: path.group_id
          cluster_id: path.cluster_id
      - text: Validate only the group config batch {data} for {group_id} on {cluster_id}.
        slots:
          data: requestBody.data
          group_id: path.group_id
          cluster_id: path.cluster_id
      method: generated
      generated: '2026-09-26'