Confluent | the Data Streaming Platform · 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-the-data-streaming-platform-compute-pools-fcpm-v2-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 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

# 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-the-data-streaming-platform-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
      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: Show compute pools in environment {environment} located 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 new compute pool for running Flink statements?
      - What goes in the spec when creating a compute pool, like cloud and max CFUs?
      instructions:
      - text: Create a compute pool with spec {spec}.
        slots:
          spec: requestBody.spec
      - text: Provision a new Flink compute pool described by {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 particular compute pool?
      - Can I check whether my compute pool is provisioned yet?
      instructions:
      - text: Show compute pool {id} in environment {environment}.
        slots:
          id: path.id
          environment: query.environment
      - text: Check the provisioning status of compute pool {id}.
        slots:
          id: path.id
      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 no longer need?
      - Can I delete a Flink compute pool from an environment?
      instructions:
      - text: Delete compute pool {id} in environment {environment}.
        slots:
          id: path.id
          environment: query.environment
      - text: Remove Flink compute pool {id}.
        slots:
          id: path.id
      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 an existing compute pool or change its name?
      - How would I raise the max CFU limit on a compute pool?
      instructions:
      - text: Update compute pool {id} with spec {spec}.
        slots:
          id: path.id
          spec: requestBody.spec
      - text: Change the max CFUs of existing pool {id} using spec {spec}.
        slots:
          id: path.id
          spec: requestBody.spec
      method: generated
      generated: '2026-09-26'