Confluent · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Keys (byok/v1) API

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

$.paths['/byok/v1/keys'].post

$.paths['/byok/v1/keys/{id}'].get

$.paths['/byok/v1/keys/{id}'].delete

$.paths['/byok/v1/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 Keys (byok/v1) API
  version: 1.0.0
extends: openapi/confluent-keys-byok-v1-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['/byok/v1/keys'].get
  update:
    x-apievangelist-phrasing:
      intent: List bring-your-own-keys
      effect: read
      questions:
      - Which customer-managed encryption keys have I registered?
      - Can I filter my BYOK keys by cloud provider or state?
      - How do I find a key by part of its ARN?
      instructions:
      - text: List all my BYOK keys.
      - text: List BYOK keys from {provider} in state {state}.
        slots:
          provider: query.provider
          state: query.state
      - text: Find the BYOK key whose identifier contains {key}.
        slots:
          key: query.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/byok/v1/keys'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a bring-your-own-key
      effect: write
      questions:
      - How do I register my own KMS key to encrypt a dedicated Kafka cluster?
      - What key details do I provide for AWS versus Azure BYOK?
      instructions:
      - text: Register BYOK key {key} named {display_name}.
        slots:
          key: requestBody.key
          display_name: requestBody.display_name
      - text: Add a customer-managed key with details {key}.
        slots:
          key: requestBody.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/byok/v1/keys/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a bring-your-own-key
      effect: read
      questions:
      - Is my registered encryption key available for cluster provisioning?
      - Can I read one BYOK key and its validation status?
      instructions:
      - text: Get BYOK key {id}.
        slots:
          id: path.id
      - text: Show the state and validation of key {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/byok/v1/keys/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a bring-your-own-key
      effect: destructive
      questions:
      - Can I remove a customer-managed key I no longer use?
      - What deletes one BYOK key record?
      instructions:
      - text: Delete BYOK key {id}.
        slots:
          id: path.id
      - text: Remove customer-managed key {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/byok/v1/keys/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a bring-your-own-key
      effect: write
      questions:
      - Can I rename a registered encryption key?
      - Which call edits a BYOK key's display name?
      instructions:
      - text: Rename BYOK key {id} to {display_name}.
        slots:
          id: path.id
          display_name: requestBody.display_name
      - text: Update key {id} with display name {display_name}.
        slots:
          id: path.id
          display_name: requestBody.display_name
      method: generated
      generated: '2026-09-26'