Confluent · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Environments (org/v2) API

6 actions 6 updates phrasing extends openapi/confluent-environments-org-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['/org/v2/environments'].get

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

$.paths['/org/v2/environments/{id}'].get

$.paths['/org/v2/environments/{id}'].delete

$.paths['/org/v2/environments/{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 Environments (org/v2) API
  version: 1.0.0
extends: openapi/confluent-environments-org-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['/org/v2/environments'].get
  update:
    x-apievangelist-phrasing:
      intent: List environments
      effect: read
      questions:
      - What environments exist in my Confluent Cloud organization?
      - How do I page through all my environments?
      instructions:
      - text: List all my environments.
      - text: Show the next page of environments after {page_token}.
        slots:
          page_token: query.page_token
      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 for my Kafka clusters?
      - Can I choose a Stream Governance package when creating an environment?
      instructions:
      - text: Create an environment named {display_name}.
        slots:
          display_name: requestBody.display_name
      - text: Create environment {display_name} with Stream Governance config {stream_governance_config}.
        slots:
          display_name: requestBody.display_name
          stream_governance_config: requestBody.stream_governance_config
      method: generated
      generated: '2026-09-26'
- target: $.paths['/org/v2/environments/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an environment
      effect: read
      questions:
      - What Stream Governance package is an environment on?
      - Can I look up one environment by ID?
      instructions:
      - text: Get environment {id}.
        slots:
          id: path.id
      - text: Show the details of environment {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/org/v2/environments/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an environment and its resources
      effect: destructive
      questions:
      - Does deleting an environment also delete the clusters inside it?
      - What removes an environment entirely?
      instructions:
      - text: Delete environment {id} and everything in it.
        slots:
          id: path.id
      - text: Tear down environment {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/org/v2/environments/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an environment
      effect: write
      questions:
      - Can I rename an existing environment?
      - How do I upgrade an environment's Stream Governance package?
      instructions:
      - text: Rename environment {id} to {display_name}.
        slots:
          id: path.id
          display_name: requestBody.display_name
      - text: Change environment {id}'s Stream Governance config to {stream_governance_config}.
        slots:
          id: path.id
          stream_governance_config: requestBody.stream_governance_config
      method: generated
      generated: '2026-09-26'