Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

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

3 actions 3 updates phrasing extends openapi/confluent-the-data-streaming-platform-materialized-table-versions-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 3

$.info

$.paths['/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/materialized-tables/{table_name}/versions'].get

$.paths['/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/materialized-tables/{table_name}/versions/{version}'].get

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 Materialized Table Versions (sql/v1) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-materialized-table-versions-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: 2
- target: $.paths['/sql/v1/organizations/{organization_id}/environments/{environment_id}/databases/{kafka_cluster_id}/materialized-tables/{table_name}/versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List versions of a materialized table
      effect: read
      questions:
      - What versions exist for one of my Flink materialized tables?
      - Can I see the history of changes to a materialized table?
      instructions:
      - text: List versions of materialized table {table_name} in cluster {kafka_cluster_id}, environment {environment_id}, org {organization_id}.
        slots:
          organization_id: path.organization_id
          environment_id: path.environment_id
          kafka_cluster_id: path.kafka_cluster_id
          table_name: path.table_name
      - text: Show version history for {table_name} on database {kafka_cluster_id} in {environment_id} for org {organization_id}.
        slots:
          organization_id: path.organization_id
          environment_id: path.environment_id
          kafka_cluster_id: path.kafka_cluster_id
          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}/versions/{version}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one version of a materialized table
      effect: read
      questions:
      - What did a materialized table's definition look like at a specific version?
      - Can I read an older version of a materialized table?
      instructions:
      - text: Get version {version} of materialized table {table_name} in cluster {kafka_cluster_id}, environment {environment_id}, org {organization_id}.
        slots:
          organization_id: path.organization_id
          environment_id: path.environment_id
          kafka_cluster_id: path.kafka_cluster_id
          table_name: path.table_name
          version: path.version
      - text: Show {table_name} at version {version} on database {kafka_cluster_id} in {environment_id} for org {organization_id}.
        slots:
          organization_id: path.organization_id
          environment_id: path.environment_id
          kafka_cluster_id: path.kafka_cluster_id
          table_name: path.table_name
          version: path.version
      method: generated
      generated: '2026-09-26'