Confluent · 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-rtce-topics-rtce-v1-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 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-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 RTCE topics for a Kafka cluster
      effect: read
      questions:
      - Which real-time context engine topics are set up on my Kafka cluster?
      - Can I filter RTCE topics by cloud or region?
      instructions:
      - text: List RTCE topics in environment {environment} for Kafka cluster {kafka_cluster}.
        slots:
          environment: query.environment
          kafka_cluster: query.spec.kafka_cluster
      - text: Show RTCE topics for cluster {kafka_cluster} in env {environment} 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: Create an RTCE topic
      effect: write
      questions:
      - How do I enable a topic for the real-time context engine?
      - What goes into an RTCE topic spec?
      instructions:
      - text: Create an RTCE topic with spec {spec}.
        slots:
          spec: requestBody.spec
      - text: Register a topic with the real-time context engine using spec {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 an RTCE topic
      effect: read
      questions:
      - What is the status of one RTCE topic?
      - Can I read an RTCE topic's configuration by name?
      instructions:
      - text: Get RTCE topic {topic_name} in environment {environment} on Kafka cluster {kafka_cluster}.
        slots:
          topic_name: path.topic_name
          environment: query.environment
          kafka_cluster: query.spec.kafka_cluster
      - text: Show the RTCE settings for topic {topic_name} (env {environment}, cluster {kafka_cluster}).
        slots:
          topic_name: path.topic_name
          environment: query.environment
          kafka_cluster: query.spec.kafka_cluster
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rtce/v1/rtce-topics/{topic_name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an RTCE topic
      effect: destructive
      questions:
      - How do I remove a topic from the real-time context engine?
      - Can I delete an RTCE topic by name?
      instructions:
      - text: Delete RTCE topic {topic_name} in environment {environment} on cluster {kafka_cluster}.
        slots:
          topic_name: path.topic_name
          environment: query.environment
          kafka_cluster: query.spec.kafka_cluster
      - text: Remove topic {topic_name} from RTCE in env {environment}, cluster {kafka_cluster}.
        slots:
          topic_name: path.topic_name
          environment: query.environment
          kafka_cluster: query.spec.kafka_cluster
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rtce/v1/rtce-topics/{topic_name}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an RTCE topic
      effect: write
      questions:
      - Can I change the spec of an existing RTCE topic?
      - Which RTCE topic settings are editable?
      instructions:
      - text: Update RTCE topic {topic_name} with spec {spec}.
        slots:
          topic_name: path.topic_name
          spec: requestBody.spec
      - text: Change the settings of existing RTCE topic {topic_name} to {spec}.
        slots:
          topic_name: path.topic_name
          spec: requestBody.spec
      method: generated
      generated: '2026-09-26'