Confluent | the Data Streaming Platform · 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-the-data-streaming-platform-tableflow-topics-tableflow-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['/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-the-data-streaming-platform-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 topics with Tableflow enabled
      effect: read
      questions:
      - Which Kafka topics have Tableflow turned on in a cluster?
      - Can I filter Tableflow topics by table format such as Iceberg or Delta?
      instructions:
      - text: List Tableflow topics on cluster {kafka_cluster} in environment {environment}.
        slots:
          environment: query.environment
          kafka_cluster: query.spec.kafka_cluster
      - text: List Tableflow topics in {table_formats} format on cluster {kafka_cluster} in {environment}.
        slots:
          table_formats: query.spec.table_formats
          environment: query.environment
          kafka_cluster: query.spec.kafka_cluster
      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 materialize a Kafka topic as an Iceberg table with Tableflow?
      - Can I choose the table format when enabling Tableflow on a topic?
      instructions:
      - text: Enable Tableflow with spec {spec}.
        slots:
          spec: requestBody.spec
      - text: Turn on Tableflow for my topic as an Iceberg table.
      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:
      - Is Tableflow running for one of my topics?
      - What table formats and storage does a Tableflow topic use?
      instructions:
      - text: Get Tableflow topic {display_name} on cluster {kafka_cluster} in environment {environment}.
        slots:
          display_name: path.display_name
          environment: query.environment
          kafka_cluster: query.spec.kafka_cluster
      - text: Show Tableflow status for {display_name} in cluster {kafka_cluster}, environment {environment}.
        slots:
          display_name: path.display_name
          environment: query.environment
          kafka_cluster: query.spec.kafka_cluster
      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 turn off Tableflow for a topic?
      - Can I stop materializing a topic into tables?
      instructions:
      - text: Delete Tableflow topic {display_name} on cluster {kafka_cluster} in environment {environment}.
        slots:
          display_name: path.display_name
          environment: query.environment
          kafka_cluster: query.spec.kafka_cluster
      - text: Disable Tableflow for {display_name} in cluster {kafka_cluster}, environment {environment}.
        slots:
          display_name: path.display_name
          environment: query.environment
          kafka_cluster: query.spec.kafka_cluster
      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:
      - How do I change the settings on a topic that already has Tableflow?
      - Can I add another table format to an existing Tableflow topic?
      instructions:
      - text: Update Tableflow topic {display_name} with spec {spec}.
        slots:
          display_name: path.display_name
          spec: requestBody.spec
      - text: Change the Tableflow settings on topic {display_name}.
        slots:
          display_name: path.display_name
      method: generated
      generated: '2026-09-26'