Confluent · 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-catalog-integrations-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/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

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 Catalog Integrations (tableflow/v1) API
  version: 1.0.0
extends: openapi/confluent-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 catalog integrations are set up for Tableflow on my Kafka cluster?
      - Can I page through catalog integrations for one environment?
      instructions:
      - text: List Tableflow catalog integrations for cluster {kafka_cluster} in environment {environment}.
        slots:
          environment: query.environment
          kafka_cluster: query.spec.kafka_cluster
      - text: Show every catalog integration on Kafka cluster {kafka_cluster} ({environment}).
        slots:
          environment: query.environment
          kafka_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 tables to an external catalog?
      - Can I set up a new catalog integration for a Kafka cluster?
      instructions:
      - text: Create a Tableflow catalog integration with spec {spec}.
        slots:
          spec: requestBody.spec
      - text: Set up a new catalog integration for Tableflow.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tableflow/v1/catalog-integrations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a Tableflow catalog integration
      effect: read
      questions:
      - What are the settings and status of a specific catalog integration?
      - Can I look up one Tableflow catalog integration by ID?
      instructions:
      - text: Show catalog integration {id} on cluster {kafka_cluster} in environment {environment}.
        slots:
          environment: query.environment
          kafka_cluster: query.spec.kafka_cluster
          id: path.id
      - text: Get the status of Tableflow catalog integration {id} ({environment}, {kafka_cluster}).
        slots:
          environment: query.environment
          kafka_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 remove a Tableflow catalog integration?
      - Can I disconnect an external catalog from my Kafka cluster's Tableflow?
      instructions:
      - text: Delete catalog integration {id} on cluster {kafka_cluster} in environment {environment}.
        slots:
          environment: query.environment
          kafka_cluster: query.spec.kafka_cluster
          id: path.id
      - text: Remove Tableflow catalog integration {id} ({environment}, {kafka_cluster}).
        slots:
          environment: query.environment
          kafka_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 configuration of an existing catalog integration?
      - Is it possible to edit a Tableflow catalog integration after it is created?
      instructions:
      - text: Update catalog integration {id} with spec {spec}.
        slots:
          id: path.id
          spec: requestBody.spec
      - text: Change the settings of Tableflow catalog integration {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'