Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Statements (query/v1alpha1) API

3 actions 3 updates phrasing extends openapi/confluent-the-data-streaming-platform-statements-query-v1alpha1-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['/query/v1alpha1'].post

$.paths['/query/v1alpha1/jobs/{statement_id}/status'].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 Statements (query/v1alpha1) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-statements-query-v1alpha1-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['/query/v1alpha1'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a SQL query
      effect: write
      questions:
      - How do I run a SQL query and get results back over HTTP?
      - What happens when a query takes longer than 30 seconds or returns over 25 MiB?
      - Can I get query results as an Arrow stream instead of JSON?
      instructions:
      - text: Run the query {query} against catalog {catalog_name} and database {database_name}.
        slots:
          query: requestBody.query
          catalog_name: requestBody.catalog_name
          database_name: requestBody.database_name
      - text: Execute {query} in {catalog_name}.{database_name} with options {options}.
        slots:
          query: requestBody.query
          catalog_name: requestBody.catalog_name
          database_name: requestBody.database_name
          options: requestBody.options
      method: generated
      generated: '2026-09-26'
- target: $.paths['/query/v1alpha1/jobs/{statement_id}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a background query's status
      effect: read
      questions:
      - Is my long-running SQL query still running or finished?
      - Can I poll the lifecycle state of an async query job?
      instructions:
      - text: Check the status of query job {statement_id}.
        slots:
          statement_id: path.statement_id
      - text: Show the lifecycle state of background statement {statement_id}.
        slots:
          statement_id: path.statement_id
      method: generated
      generated: '2026-09-26'