Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Materialized Tables (sql/v1) API

6 actions 6 updates phrasing extends openapi/confluent-the-data-streaming-platform-materialized-tables-sql-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['/sql/v1/organizations/{organization_id}/environments/{environment_id}/materialized-tables'].get
$.paths['/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/materialized-tables'].post
$.paths['/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/materialized-tables/{table_name}'].get
$.paths['/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/materialized-tables/{table_name}'].put
$.paths['/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/materialized-tables/{table_name}'].delete

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 Materialized Tables (sql/v1) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-materialized-tables-sql-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['/sql/v1/organizations/{organization_id}/environments/{environment_id}/materialized-tables'].get
  update:
    x-apievangelist-phrasing:
      intent: List materialized tables in an environment
      effect: read
      questions:
      - Which materialized tables exist in my Flink SQL environment?
      - Can I page through every materialized table in an environment?
      instructions:
      - text: List materialized tables in environment {environment_id} of org {organization_id}.
        slots:
          environment_id: path.environment_id
          organization_id: path.organization_id
      - text: Show {page_size} materialized tables from environment {environment_id}, org {organization_id}.
        slots:
          page_size: query.page_size
          environment_id: path.environment_id
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/materialized-tables'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a materialized table
      effect: write
      questions:
      - How do I create a materialized table from a Flink SQL query?
      - What does a materialized table's spec include, like the query and compute pool?
      instructions:
      - text: Create materialized table {name} in database {kafka_cluster_id}, environment {environment_id}, org {organization_id} with spec {spec}.
        slots:
          name: requestBody.name
          kafka_cluster_id: path.kafka_cluster_id
          environment_id: path.environment_id
          organization_id: path.organization_id
          spec: requestBody.spec
      - text: Materialize a new table {name} on Kafka cluster {kafka_cluster_id}.
        slots:
          name: requestBody.name
          kafka_cluster_id: path.kafka_cluster_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/materialized-tables/{table_name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a materialized table
      effect: read
      questions:
      - What query and columns define a specific materialized table?
      - Can I check whether a materialized table is stopped?
      instructions:
      - text: Show materialized table {table_name} in database {kafka_cluster_id}, environment {environment_id}, org {organization_id}.
        slots:
          table_name: path.table_name
          kafka_cluster_id: path.kafka_cluster_id
          environment_id: path.environment_id
          organization_id: path.organization_id
      - text: Read the definition of materialized table {table_name}.
        slots:
          table_name: path.table_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/materialized-tables/{table_name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Evolve a materialized table
      effect: write
      questions:
      - Can I change the query or compute pool behind an existing materialized table?
      - How would I stop a materialized table or evolve its columns?
      instructions:
      - text: Evolve materialized table {table_name} in database {kafka_cluster_id}, environment {environment_id}, org {organization_id} with spec {spec}.
        slots:
          table_name: path.table_name
          kafka_cluster_id: path.kafka_cluster_id
          environment_id: path.environment_id
          organization_id: path.organization_id
          spec: requestBody.spec
      - text: Update the query of materialized table {table_name} using spec {spec}.
        slots:
          table_name: path.table_name
          spec: requestBody.spec
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/materialized-tables/{table_name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a materialized table
      effect: destructive
      questions:
      - How do I drop a materialized table I no longer need?
      - Can I delete one materialized table by name?
      instructions:
      - text: Delete materialized table {table_name} from database {kafka_cluster_id}, environment {environment_id}, org {organization_id}.
        slots:
          table_name: path.table_name
          kafka_cluster_id: path.kafka_cluster_id
          environment_id: path.environment_id
          organization_id: path.organization_id
      - text: Drop materialized table {table_name}.
        slots:
          table_name: path.table_name
      method: generated
      generated: '2026-09-26'