Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

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

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

$.info
$.paths['/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements'].get
$.paths['/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements'].post
$.paths['/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}'].get
$.paths['/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}'].put
$.paths['/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}'].delete
$.paths['/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}'].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 Statements (sql/v1) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-statements-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: 6
- target: $.paths['/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements'].get
  update:
    x-apievangelist-phrasing:
      intent: List Flink SQL statements
      effect: read
      questions:
      - Which Flink SQL statements are running in my environment?
      - Can I list only the statements on a particular compute pool?
      instructions:
      - text: List Flink SQL statements in environment {environment_id} of organization {organization_id}.
        slots:
          organization_id: path.organization_id
          environment_id: path.environment_id
      - text: List statements in org {organization_id}, environment {environment_id} on compute pool {pool}.
        slots:
          organization_id: path.organization_id
          environment_id: path.environment_id
          pool: query.spec.compute_pool_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a Flink SQL statement
      effect: write
      questions:
      - How do I run a Flink SQL query through the API?
      - Can I submit a SQL statement to a specific compute pool?
      instructions:
      - text: Submit Flink SQL statement {name} in org {organization_id}, environment {environment_id}.
        slots:
          organization_id: path.organization_id
          environment_id: path.environment_id
          name: requestBody.name
      - text: Run this SQL {spec} as a new statement in environment {environment_id} of org {organization_id}.
        slots:
          organization_id: path.organization_id
          environment_id: path.environment_id
          spec: requestBody.spec
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Flink SQL statement
      effect: read
      questions:
      - What is the current phase of a Flink SQL statement I submitted?
      - Can I see the SQL text and status of one statement by name?
      instructions:
      - text: Show statement {statement_name} in org {organization_id}, environment {environment_id}.
        slots:
          organization_id: path.organization_id
          environment_id: path.environment_id
          statement_name: path.statement_name
      - text: Check the status of Flink statement {statement_name} in environment {environment_id}, org {organization_id}.
        slots:
          organization_id: path.organization_id
          environment_id: path.environment_id
          statement_name: path.statement_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a Flink SQL statement's spec
      effect: write
      questions:
      - Can I stop a running statement or move it to another compute pool with a full update?
      - Why does updating a statement fail with a conflict if it changed since I read it?
      instructions:
      - text: Update statement {statement_name} in org {organization_id}, environment {environment_id} with spec {spec}.
        slots:
          organization_id: path.organization_id
          environment_id: path.environment_id
          statement_name: path.statement_name
          spec: requestBody.spec
      - text: Replace the full definition of statement {statement_name} in environment {environment_id}, org {organization_id}.
        slots:
          organization_id: path.organization_id
          environment_id: path.environment_id
          statement_name: path.statement_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Flink SQL statement
      effect: destructive
      questions:
      - How do I delete a Flink SQL statement I no longer need?
      - Does deleting a statement stop it from running?
      instructions:
      - text: Delete statement {statement_name} in org {organization_id}, environment {environment_id}.
        slots:
          organization_id: path.organization_id
          environment_id: path.environment_id
          statement_name: path.statement_name
      - text: Remove Flink SQL statement {statement_name} from environment {environment_id} of org {organization_id}.
        slots:
          organization_id: path.organization_id
          environment_id: path.environment_id
          statement_name: path.statement_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sql/v1/organizations/{organization_id}/environments/{environment_id}/statements/{statement_name}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch a Flink SQL statement
      effect: write
      questions:
      - Can I change just part of a statement without sending its whole definition?
      - Is partial patching of Flink statements available (early access)?
      instructions:
      - text: Patch statement {statement_name} in org {organization_id}, environment {environment_id}.
        slots:
          organization_id: path.organization_id
          environment_id: path.environment_id
          statement_name: path.statement_name
      - text: Apply a partial patch to Flink statement {statement_name} in environment {environment_id} of org {organization_id}.
        slots:
          organization_id: path.organization_id
          environment_id: path.environment_id
          statement_name: path.statement_name
      method: generated
      generated: '2026-09-26'