Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Rtce Topics (rtce/v1) API

6 actions 6 updates phrasing extends openapi/confluent-the-data-streaming-platform-rtce-topics-rtce-v1-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 6

$.info
$.paths['/rtce/v1/rtce-topics'].get
$.paths['/rtce/v1/rtce-topics'].post
$.paths['/rtce/v1/rtce-topics/{topic_name}'].get
$.paths['/rtce/v1/rtce-topics/{topic_name}'].delete
$.paths['/rtce/v1/rtce-topics/{topic_name}'].patch

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 Rtce Topics (rtce/v1) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-rtce-topics-rtce-v1-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['/rtce/v1/rtce-topics'].get
  update:
    x-apievangelist-phrasing:
      intent: List real-time context engine topics
      effect: read
      questions:
      - Which topics are enabled for the real-time context engine on my Kafka cluster?
      - Can I filter RTCE topics by cloud and region?
      instructions:
      - text: List RTCE topics in environment {environment} on Kafka cluster {kafka_cluster}.
        slots:
          environment: query.environment
          kafka_cluster: query.spec.kafka_cluster
      - text: Show RTCE topics for cluster {kafka_cluster} in environment {environment} located in region {region}.
        slots:
          kafka_cluster: query.spec.kafka_cluster
          environment: query.environment
          region: query.spec.region
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rtce/v1/rtce-topics'].post
  update:
    x-apievangelist-phrasing:
      intent: Enable a topic for the real-time context engine
      effect: write
      questions:
      - How do I enable a Kafka topic for the real-time context engine?
      - What spec does a new RTCE topic need?
      instructions:
      - text: Create an RTCE topic with spec {spec}.
        slots:
          spec: requestBody.spec
      - text: Enable real-time context serving for the topic described in {spec}.
        slots:
          spec: requestBody.spec
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rtce/v1/rtce-topics/{topic_name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a real-time context engine topic
      effect: read
      questions:
      - What is the status of one RTCE topic?
      - Can I read the settings of a single real-time context engine topic?
      instructions:
      - text: Show RTCE topic {topic_name} on cluster {kafka_cluster} in environment {environment}.
        slots:
          topic_name: path.topic_name
          kafka_cluster: query.spec.kafka_cluster
          environment: query.environment
      - text: Read RTCE topic {topic_name}.
        slots:
          topic_name: path.topic_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rtce/v1/rtce-topics/{topic_name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a real-time context engine topic
      effect: destructive
      questions:
      - How do I stop serving a topic through the real-time context engine?
      - Can I delete an RTCE topic from a Kafka cluster?
      instructions:
      - text: Delete RTCE topic {topic_name} on cluster {kafka_cluster} in environment {environment}.
        slots:
          topic_name: path.topic_name
          kafka_cluster: query.spec.kafka_cluster
          environment: query.environment
      - text: Remove RTCE topic {topic_name}.
        slots:
          topic_name: path.topic_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rtce/v1/rtce-topics/{topic_name}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a real-time context engine topic
      effect: write
      questions:
      - Can I change the settings of an existing RTCE topic?
      - Which RTCE topic fields are updatable?
      instructions:
      - text: Update RTCE topic {topic_name} with spec {spec}.
        slots:
          topic_name: path.topic_name
          spec: requestBody.spec
      - text: Modify existing RTCE topic {topic_name} using {spec}.
        slots:
          topic_name: path.topic_name
          spec: requestBody.spec
      method: generated
      generated: '2026-09-26'