Confluent · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Tableflow Topics (tableflow/v1) API

6 actions 6 updates phrasing extends openapi/confluent-tableflow-topics-tableflow-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['/tableflow/v1/tableflow-topics'].get
$.paths['/tableflow/v1/tableflow-topics'].post
$.paths['/tableflow/v1/tableflow-topics/{display_name}'].get
$.paths['/tableflow/v1/tableflow-topics/{display_name}'].delete
$.paths['/tableflow/v1/tableflow-topics/{display_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 Tableflow Topics (tableflow/v1) API
  version: 1.0.0
extends: openapi/confluent-tableflow-topics-tableflow-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['/tableflow/v1/tableflow-topics'].get
  update:
    x-apievangelist-phrasing:
      intent: List Tableflow-enabled topics
      effect: read
      questions:
      - Which Kafka topics have Tableflow turned on in a cluster?
      - Can I list only the Tableflow topics materialized as Iceberg or Delta?
      instructions:
      - text: List Tableflow topics on cluster {kafka_cluster} in environment {environment}.
        slots:
          kafka_cluster: query.spec.kafka_cluster
          environment: query.environment
      - text: List Tableflow topics in {kafka_cluster} of {environment} using table format {table_formats}.
        slots:
          kafka_cluster: query.spec.kafka_cluster
          table_formats: query.spec.table_formats
          environment: query.environment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tableflow/v1/tableflow-topics'].post
  update:
    x-apievangelist-phrasing:
      intent: Enable Tableflow on a topic
      effect: write
      questions:
      - How do I turn a Kafka topic into an Iceberg or Delta table?
      - What spec do I send to enable Tableflow for a topic?
      instructions:
      - text: Enable Tableflow with spec {spec}.
        slots:
          spec: requestBody.spec
      - text: Materialize a topic as a table using Tableflow spec {spec}.
        slots:
          spec: requestBody.spec
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tableflow/v1/tableflow-topics/{display_name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Tableflow topic
      effect: read
      questions:
      - What is the Tableflow status of one of my topics?
      - Can I see the table formats and storage for a Tableflow topic?
      instructions:
      - text: Get Tableflow topic {display_name} on cluster {kafka_cluster} in {environment}.
        slots:
          display_name: path.display_name
          kafka_cluster: query.spec.kafka_cluster
          environment: query.environment
      - text: Show Tableflow status for topic {display_name} in {kafka_cluster}, environment {environment}.
        slots:
          display_name: path.display_name
          kafka_cluster: query.spec.kafka_cluster
          environment: query.environment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tableflow/v1/tableflow-topics/{display_name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Disable Tableflow on a topic
      effect: destructive
      questions:
      - How do I stop materializing a topic as a table?
      - Does deleting a Tableflow topic delete the Kafka topic itself?
      instructions:
      - text: Disable Tableflow on topic {display_name} in cluster {kafka_cluster}, environment {environment}.
        slots:
          display_name: path.display_name
          kafka_cluster: query.spec.kafka_cluster
          environment: query.environment
      - text: Delete the Tableflow topic {display_name} from {kafka_cluster} in {environment}.
        slots:
          display_name: path.display_name
          kafka_cluster: query.spec.kafka_cluster
          environment: query.environment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tableflow/v1/tableflow-topics/{display_name}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a Tableflow topic
      effect: write
      questions:
      - Can I change the table formats or retention of a Tableflow topic?
      - Which call edits Tableflow settings on a topic already enabled?
      instructions:
      - text: Update Tableflow topic {display_name} with spec {spec}.
        slots:
          display_name: path.display_name
          spec: requestBody.spec
      - text: Change the Tableflow settings of {display_name} to {spec}.
        slots:
          display_name: path.display_name
          spec: requestBody.spec
      method: generated
      generated: '2026-09-26'