Confluent · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Compute Pools (fcpm/v2) API

6 actions 6 updates phrasing extends openapi/confluent-compute-pools-fcpm-v2-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 6

$.info
$.paths['/fcpm/v2/compute-pools'].get
$.paths['/fcpm/v2/compute-pools'].post
$.paths['/fcpm/v2/compute-pools/{id}'].get
$.paths['/fcpm/v2/compute-pools/{id}'].delete
$.paths['/fcpm/v2/compute-pools/{id}'].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 Compute Pools (fcpm/v2) API
  version: 1.0.0
extends: openapi/confluent-compute-pools-fcpm-v2-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: 5
- target: $.paths['/fcpm/v2/compute-pools'].get
  update:
    x-apievangelist-phrasing:
      intent: List Flink compute pools in an environment
      effect: read
      questions:
      - Which Flink compute pools exist in my environment?
      - Can I filter compute pools by region or network?
      instructions:
      - text: List compute pools in environment {environment}.
        slots:
          environment: query.environment
      - text: List Flink compute pools in environment {environment} in region {region}.
        slots:
          environment: query.environment
          region: query.spec.region
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fcpm/v2/compute-pools'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Flink compute pool
      effect: write
      questions:
      - How do I provision a compute pool to run Flink SQL statements in Confluent Cloud?
      - What goes into a compute pool spec, like cloud, region and max CFUs?
      instructions:
      - text: Create a Flink compute pool with spec {spec}.
        slots:
          spec: requestBody.spec
      - text: 'Provision a new compute pool for Flink using this spec: {spec}.'
        slots:
          spec: requestBody.spec
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fcpm/v2/compute-pools/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Flink compute pool
      effect: read
      questions:
      - What is the status and size of a specific compute pool?
      - Is my compute pool provisioned yet?
      instructions:
      - text: Get compute pool {id} in environment {environment}.
        slots:
          id: path.id
          environment: query.environment
      - text: Show the status of Flink pool {id} in environment {environment}.
        slots:
          id: path.id
          environment: query.environment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fcpm/v2/compute-pools/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Flink compute pool
      effect: destructive
      questions:
      - How do I tear down a compute pool I'm not using anymore?
      - Can I delete a compute pool from a specific environment?
      instructions:
      - text: Delete compute pool {id} in environment {environment}.
        slots:
          id: path.id
          environment: query.environment
      - text: Tear down Flink pool {id} from environment {environment}.
        slots:
          id: path.id
          environment: query.environment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/fcpm/v2/compute-pools/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a Flink compute pool
      effect: write
      questions:
      - Can I resize a compute pool or rename it after creation?
      - How do I change the max CFU limit on an existing compute pool?
      instructions:
      - text: Update compute pool {id} with spec {spec}.
        slots:
          id: path.id
          spec: requestBody.spec
      - text: Change the settings of existing Flink pool {id} to {spec}.
        slots:
          id: path.id
          spec: requestBody.spec
      method: generated
      generated: '2026-09-26'