Confluent · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud API Keys (iam/v2) API

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

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

$.paths['/iam/v2/api-keys/{id}'].get

$.paths['/iam/v2/api-keys/{id}'].delete

$.paths['/iam/v2/api-keys/{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 API Keys (iam/v2) API
  version: 1.0.0
extends: openapi/confluent-api-keys-iam-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['/iam/v2/api-keys'].get
  update:
    x-apievangelist-phrasing:
      intent: List API keys in the organization
      effect: read
      questions:
      - Which API keys exist in my Confluent Cloud organization?
      - Can I list only the API keys owned by one service account or scoped to one cluster?
      instructions:
      - text: List all API keys.
      - text: List API keys owned by {owner} for resource {resource}.
        slots:
          owner: query.spec.owner
          resource: query.spec.resource
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/api-keys'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an API key
      effect: write
      questions:
      - How do I create an API key for a service account to use against a Kafka cluster?
      - Can I create a Cloud API key that isn't tied to one resource?
      instructions:
      - text: Create an API key with spec {spec}.
        slots:
          spec: requestBody.spec
      - text: Create a new API key for the owner and resource in {spec}.
        slots:
          spec: requestBody.spec
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/api-keys/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one API key
      effect: read
      questions:
      - Who owns a given API key and what resource is it for?
      - What details can I read back about a single API key by ID?
      instructions:
      - text: Get API key {id}.
        slots:
          id: path.id
      - text: Show the owner and resource of API key {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/api-keys/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an API key
      effect: destructive
      questions:
      - How do I revoke an API key that may have leaked?
      - Does deleting an API key immediately cut off clients that use it?
      instructions:
      - text: Delete API key {id}.
        slots:
          id: path.id
      - text: Revoke API key {id} now.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/api-keys/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an API key's details
      effect: write
      questions:
      - Can I rename or change the description on an existing API key?
      - Is it possible to edit an API key's metadata after creating it?
      instructions:
      - text: Update API key {id} with spec {spec}.
        slots:
          id: path.id
          spec: requestBody.spec
      - text: Change the display name and description of API key {id} per {spec}.
        slots:
          id: path.id
          spec: requestBody.spec
      method: generated
      generated: '2026-09-26'