Confluent · OpenAPI Overlay 1.0.0

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

2 actions 2 updates phrasing extends openapi/confluent-records-v3-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Confluent's API. It is a proposal applied on top of the contract, not a document Confluent publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/kafka/v3/clusters/{cluster_id}/topics/{topic_name}/records'].post

OpenAPI Overlay

# 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 Records (v3) API
  version: 1.0.0
extends: openapi/confluent-records-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: 1
- target: $.paths['/kafka/v3/clusters/{cluster_id}/topics/{topic_name}/records'].post
  update:
    x-apievangelist-phrasing:
      intent: Produce records to a Kafka topic
      effect: write
      questions:
      - How do I send a message to a Kafka topic over REST?
      - Can I produce to a specific partition with a key and headers?
      instructions:
      - text: Produce a record with value {value} to topic {topic_name} in cluster {cluster_id}.
        slots:
          value: requestBody.value
          topic_name: path.topic_name
          cluster_id: path.cluster_id
      - text: Send key {key} and value {value} to partition {partition_id} of {topic_name} on cluster {cluster_id}.
        slots:
          key: requestBody.key
          value: requestBody.value
          partition_id: requestBody.partition_id
          topic_name: path.topic_name
          cluster_id: path.cluster_id
      method: generated
      generated: '2026-09-26'