Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Statement Results (sql/v1) API

2 actions 2 updates phrasing extends openapi/confluent-the-data-streaming-platform-statement-results-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 2

$.info

$.paths['/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{name}/results'].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 Statement Results (sql/v1) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-statement-results-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: 1
- target: $.paths['/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{name}/results'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a Flink SQL statement's results
      effect: read
      questions:
      - How do I fetch the rows returned by a Flink SQL query?
      - Can I page through a statement's results?
      instructions:
      - text: Get the results of statement {name} in org {organization_id}, environment {environment_id}.
        slots:
          organization_id: path.organization_id
          environment_id: path.environment_id
          name: path.name
      - text: Fetch the next page {page_token} of results for statement {name} in environment {environment_id}, org {organization_id}.
        slots:
          organization_id: path.organization_id
          environment_id: path.environment_id
          name: path.name
          page_token: query.page_token
      method: generated
      generated: '2026-09-26'