Confluent · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Kafka REST Environments API

3 actions 3 updates phrasing extends openapi/confluent-environments-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 3

$.info
$.paths['/org/v2/environments'].get
$.paths['/org/v2/environments'].post

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 Kafka REST Environments API
  version: 1.0.0
extends: openapi/confluent-environments-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['/org/v2/environments'].get
  update:
    x-apievangelist-phrasing:
      intent: List Confluent Cloud environments
      effect: read
      questions:
      - Which environments exist in my Confluent Cloud organization?
      - Can I see all environment IDs and names?
      instructions:
      - text: List my Confluent Cloud environments.
      - text: Show every environment in my organization.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/org/v2/environments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an environment
      effect: write
      questions:
      - How do I create a new environment to group my clusters?
      - Can I give a new environment a display name?
      instructions:
      - text: Create an environment named {display_name}.
        slots:
          display_name: requestBody.display_name
      - text: Set up a new environment called {display_name}.
        slots:
          display_name: requestBody.display_name
      method: generated
      generated: '2026-09-26'