Confluent · OpenAPI Overlay 1.0.0

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

7 actions 7 updates phrasing extends openapi/confluent-statements-sql-v1-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Confluent's API. It is a proposal applied on top of the contract, not a document Confluent 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-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 filter my SQL statements by compute pool or label?
      instructions:
      - text: List the SQL statements in environment {environment_id} of org {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 new Flink SQL statement through the API?
      - Can I give a statement my own name when I submit it?
      instructions:
      - text: Create statement {name} in environment {environment_id} of org {organization_id}.
        slots:
          organization_id: path.organization_id
          environment_id: path.environment_id
          name: requestBody.name
      - text: Submit a SQL statement with spec {spec} to org {organization_id}, environment {environment_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: Read a Flink SQL statement
      effect: read
      questions:
      - What is the current status and result of one of my SQL statements?
      - Can I fetch a single statement by its name?
      instructions:
      - text: Show 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
      - text: Get the status of SQL statement {statement_name} (org {organization_id}, env {environment_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
      effect: write
      questions:
      - Why does updating a statement fail with a 409 Conflict?
      - Can I replace a statement's full spec, for example to stop it?
      instructions:
      - text: Update statement {statement_name} in org {organization_id}, env {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} (org {organization_id}, env {environment_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 remove a SQL statement I no longer need?
      - Can I delete a statement by name from an environment?
      instructions:
      - text: Delete 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
      - text: Remove SQL statement {statement_name} from org {organization_id}, env {environment_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:
      - Is there an early-access way to change only part of a SQL statement?
      - Can I patch a statement instead of sending the whole resource?
      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 change to SQL statement {statement_name} (org {organization_id}, env {environment_id}).
        slots:
          organization_id: path.organization_id
          environment_id: path.environment_id
          statement_name: path.statement_name
      method: generated
      generated: '2026-09-26'