Confluent · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Kafka REST API Keys API

3 actions 3 updates phrasing extends openapi/confluent-api-keys-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['/iam/v2/api-keys'].get

$.paths['/iam/v2/api-keys'].post

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 Kafka REST API Keys API
  version: 1.0.0
extends: openapi/confluent-api-keys-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['/iam/v2/api-keys'].get
  update:
    x-apievangelist-phrasing:
      intent: List API keys (subset spec)
      effect: read
      questions:
      - What API keys does my Confluent Cloud account have?
      - Can I get a quick list of every API key in the account?
      instructions:
      - text: List my API keys.
      - text: Show all Confluent Cloud API keys.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/api-keys'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an API key (subset spec)
      effect: write
      questions:
      - How do I generate a new API key for Kafka REST access?
      - Can I create an API key by supplying just an owner and resource spec?
      instructions:
      - text: Create an API key with spec {spec}.
        slots:
          spec: requestBody.spec
      - text: Generate a new API key {id} for the owner in {spec}.
        slots:
          id: requestBody.id
          spec: requestBody.spec
      method: generated
      generated: '2026-09-26'