# 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 Data Encryption Keys (v1) API
  version: 1.0.0
extends: openapi/confluent-data-encryption-keys-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: 9
- target: $.paths['/dek-registry/v1/keks/{name}/deks'].get
  update:
    x-apievangelist-phrasing:
      intent: List DEK subjects under a KEK
      effect: read
      questions:
      - Which subjects have data encryption keys under a given key encryption key?
      - Can I include soft-deleted DEKs when listing subjects for a KEK?
      instructions:
      - text: List DEK subjects under KEK {name}.
        slots:
          name: path.name
      - text: Show DEK subjects for KEK {name}, including deleted ones, {limit} at a time.
        slots:
          name: path.name
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dek-registry/v1/keks/{name}/deks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a data encryption key
      effect: write
      questions:
      - How do I register a new data encryption key for a subject in Schema Registry?
      - Can I choose the encryption algorithm when creating a DEK?
      instructions:
      - text: Create a DEK for subject {subject} under KEK {name}.
        slots:
          subject: requestBody.subject
          name: path.name
      - text: Create a DEK for subject {subject} under KEK {name} using algorithm {algorithm}.
        slots:
          subject: requestBody.subject
          name: path.name
          algorithm: requestBody.algorithm
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dek-registry/v1/keks/{name}/deks/{subject}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the latest DEK for a subject
      effect: read
      questions:
      - What data encryption key is currently used for a subject?
      - Can I look up a subject's DEK for a specific algorithm?
      instructions:
      - text: Get the DEK for subject {subject} under KEK {name}.
        slots:
          subject: path.subject
          name: path.name
      - text: Fetch subject {subject}'s DEK under KEK {name} for algorithm {algorithm}.
        slots:
          subject: path.subject
          name: path.name
          algorithm: query.algorithm
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dek-registry/v1/keks/{name}/deks/{subject}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete all versions of a DEK
      effect: destructive
      questions:
      - How do I delete every version of a subject's data encryption key?
      - Is it possible to permanently delete a DEK rather than soft-delete it?
      instructions:
      - text: Delete all DEK versions for subject {subject} under KEK {name}.
        slots:
          subject: path.subject
          name: path.name
      - text: Permanently delete every version of the DEK for {subject} under KEK {name}.
        slots:
          subject: path.subject
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dek-registry/v1/keks/{name}/deks/{subject}/versions/{version}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a specific DEK version
      effect: read
      questions:
      - Can I retrieve an older version of a subject's DEK?
      - What does version 2 of a data encryption key contain?
      instructions:
      - text: Get DEK version {version} for subject {subject} under KEK {name}.
        slots:
          version: path.version
          subject: path.subject
          name: path.name
      - text: Show version {version} of the {subject} DEK in KEK {name}.
        slots:
          version: path.version
          subject: path.subject
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dek-registry/v1/keks/{name}/deks/{subject}/versions/{version}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one DEK version
      effect: destructive
      questions:
      - How do I delete just one version of a DEK and keep the rest?
      - Can a single DEK version be permanently removed?
      instructions:
      - text: Delete DEK version {version} for subject {subject} under KEK {name}.
        slots:
          version: path.version
          subject: path.subject
          name: path.name
      - text: Permanently delete version {version} of the {subject} DEK in KEK {name}.
        slots:
          version: path.version
          subject: path.subject
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dek-registry/v1/keks/{name}/deks/{subject}/versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List versions of a DEK
      effect: read
      questions:
      - What versions exist for a subject's data encryption key?
      - Can I page through DEK versions including deleted ones?
      instructions:
      - text: List DEK versions for subject {subject} under KEK {name}.
        slots:
          subject: path.subject
          name: path.name
      - text: List version numbers of the {subject} DEK in KEK {name}, {limit} per page.
        slots:
          subject: path.subject
          name: path.name
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dek-registry/v1/keks/{name}/deks/{subject}/versions/{version}/undelete'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore a soft-deleted DEK version
      effect: write
      questions:
      - Can I recover a DEK version I soft-deleted by mistake?
      - How do I undelete one specific DEK version?
      instructions:
      - text: Undelete DEK version {version} for subject {subject} under KEK {name}.
        slots:
          version: path.version
          subject: path.subject
          name: path.name
      - text: Restore deleted version {version} of the {subject} DEK in KEK {name}.
        slots:
          version: path.version
          subject: path.subject
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dek-registry/v1/keks/{name}/deks/{subject}/undelete'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore all soft-deleted versions of a DEK
      effect: write
      questions:
      - Can I undelete every version of a data encryption key at once?
      - Is there a way to bring back all deleted DEK versions for a subject?
      instructions:
      - text: Undelete all DEK versions for subject {subject} under KEK {name}.
        slots:
          subject: path.subject
          name: path.name
      - text: Restore every deleted version of the {subject} DEK in KEK {name} for algorithm {algorithm}.
        slots:
          subject: path.subject
          name: path.name
          algorithm: query.algorithm
      method: generated
      generated: '2026-09-26'