Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

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

6 actions 6 updates phrasing extends openapi/confluent-the-data-streaming-platform-keys-byok-v1-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Confluent | the Data Streaming Platform's API. It is a proposal applied on top of the contract, not a document Confluent | the Data Streaming Platform 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-the-data-streaming-platform-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 encryption keys
      effect: read
      questions:
      - Which self-managed encryption keys have I registered for my clusters?
      - Can I filter my BYOK keys by cloud provider or state?
      instructions:
      - text: List my BYOK keys.
      - text: List BYOK keys from cloud {provider} in state {state}.
        slots:
          provider: query.provider
          state: query.state
      - text: List BYOK keys in validation region {validation_region}.
        slots:
          validation_region: query.validation_region
      method: generated
      generated: '2026-09-26'
- target: $.paths['/byok/v1/keys'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a bring-your-own encryption key
      effect: write
      questions:
      - How do I register my own KMS key to encrypt a dedicated cluster?
      - Can I add a customer-managed key from my cloud provider?
      instructions:
      - text: Register BYOK key {key} named {display_name}.
        slots:
          key: requestBody.key
          display_name: requestBody.display_name
      - text: Create a self-managed encryption key from {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:
      - Has my self-managed encryption key passed validation?
      - What cloud key does a BYOK record point to?
      instructions:
      - text: Get BYOK key {id}.
        slots:
          id: path.id
      - text: Show the validation status of BYOK 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:
      - How do I remove a self-managed encryption key I registered?
      - Can I delete a BYOK key that no cluster uses?
      instructions:
      - text: Delete BYOK key {id}.
        slots:
          id: path.id
      - text: Remove self-managed encryption key {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/byok/v1/keys/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename a bring-your-own key
      effect: write
      questions:
      - How do I change the display name of a BYOK key?
      - Can I update a self-managed key record after registering it?
      instructions:
      - text: Rename BYOK key {id} to {display_name}.
        slots:
          id: path.id
          display_name: requestBody.display_name
      - text: Update BYOK key record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'