Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

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

2 actions 2 updates phrasing extends openapi/confluent-the-data-streaming-platform-records-v3-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Confluent | the Data Streaming Platform's API. It is a proposal applied on top of the contract, not a document Confluent | the Data Streaming Platform 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

Raw ↑ 
# 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-the-data-streaming-platform-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 a record to a specific partition with headers?
      instructions:
      - text: Produce a record with value {value} to topic {topic} on cluster {cluster}.
        slots:
          value: requestBody.value
          topic: path.topic_name
          cluster: path.cluster_id
      - text: Send key {key} and value {value} to partition {partition} of {topic}.
        slots:
          key: requestBody.key
          value: requestBody.value
          partition: requestBody.partition_id
          topic: path.topic_name
      method: generated
      generated: '2026-09-26'