Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Catalog Integrations (tableflow/v1) API

6 actions 6 updates phrasing extends openapi/confluent-the-data-streaming-platform-catalog-integrations-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/catalog-integrations'].get

$.paths['/tableflow/v1/catalog-integrations'].post

$.paths['/tableflow/v1/catalog-integrations/{id}'].get

$.paths['/tableflow/v1/catalog-integrations/{id}'].delete

$.paths['/tableflow/v1/catalog-integrations/{id}'].patch

OpenAPI Overlay

# 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 Catalog Integrations (tableflow/v1) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-catalog-integrations-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/catalog-integrations'].get
  update:
    x-apievangelist-phrasing:
      intent: List Tableflow catalog integrations
      effect: read
      questions:
      - Which external catalogs is Tableflow publishing tables to for my cluster?
      - Can I list catalog integrations for one Kafka cluster?
      instructions:
      - text: List Tableflow catalog integrations for cluster {cluster} in environment {environment}.
        slots:
          environment: query.environment
          cluster: query.spec.kafka_cluster
      - text: Show every catalog integration on Kafka cluster {cluster} in {environment}.
        slots:
          environment: query.environment
          cluster: query.spec.kafka_cluster
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tableflow/v1/catalog-integrations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Tableflow catalog integration
      effect: write
      questions:
      - How do I connect Tableflow to an external data catalog?
      - Can I make my Tableflow tables discoverable in an external catalog?
      instructions:
      - text: Create a Tableflow catalog integration with spec {spec}.
        slots:
          spec: requestBody.spec
      - text: Set up a new catalog integration for Tableflow using {spec}.
        slots:
          spec: requestBody.spec
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tableflow/v1/catalog-integrations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Tableflow catalog integration
      effect: read
      questions:
      - What is the status of a particular Tableflow catalog integration?
      - Can I read one catalog integration's config by its id?
      instructions:
      - text: Show catalog integration {id} on cluster {cluster} in environment {environment}.
        slots:
          environment: query.environment
          cluster: query.spec.kafka_cluster
          id: path.id
      - text: Get Tableflow catalog integration {id} for cluster {cluster}, environment {environment}.
        slots:
          environment: query.environment
          cluster: query.spec.kafka_cluster
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tableflow/v1/catalog-integrations/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Tableflow catalog integration
      effect: destructive
      questions:
      - How do I stop Tableflow from publishing to an external catalog?
      - Can I remove a catalog integration from a cluster?
      instructions:
      - text: Delete catalog integration {id} on cluster {cluster} in environment {environment}.
        slots:
          environment: query.environment
          cluster: query.spec.kafka_cluster
          id: path.id
      - text: Remove Tableflow catalog integration {id} from cluster {cluster}, environment {environment}.
        slots:
          environment: query.environment
          cluster: query.spec.kafka_cluster
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tableflow/v1/catalog-integrations/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a Tableflow catalog integration
      effect: write
      questions:
      - Can I change the settings of an existing Tableflow catalog integration?
      - Is it possible to rename a catalog integration after it's created?
      instructions:
      - text: Update Tableflow catalog integration {id} with spec {spec}.
        slots:
          id: path.id
          spec: requestBody.spec
      - text: Change the settings of catalog integration {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'