# 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-the-data-streaming-platform-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 DEK subjects when listing them?
      instructions:
      - text: List the DEK subjects under KEK {name}.
        slots:
          name: path.name
      - text: Show up to {limit} DEK subjects for KEK {name}, including deleted ones.
        slots:
          limit: query.limit
          name: path.name
      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 create a data encryption key for a subject under my KEK?
      - Can I supply my own encrypted key material 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 is the current data encryption key for a subject?
      - Can I look up a subject's DEK for a specific encryption algorithm?
      instructions:
      - text: Get the DEK for subject {subject} under KEK {name}.
        slots:
          subject: path.subject
          name: path.name
      - text: Fetch the {algorithm} DEK for subject {subject} in KEK {name}.
        slots:
          algorithm: query.algorithm
          subject: path.subject
          name: path.name
      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?
      - Can I permanently remove a DEK instead of soft-deleting it?
      instructions:
      - text: Delete all DEK versions for subject {subject} under KEK {name}.
        slots:
          subject: path.subject
          name: path.name
      - text: Permanently delete every DEK version of {subject} in KEK {name} with permanent={permanent}.
        slots:
          subject: path.subject
          name: path.name
          permanent: query.permanent
      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:
      - How can I retrieve an older version of a subject's data encryption key?
      - Can I read a DEK version that was soft-deleted?
      instructions:
      - text: Get version {version} of the DEK for subject {subject} under KEK {name}.
        slots:
          version: path.version
          subject: path.subject
          name: path.name
      - text: Show DEK version {version} of {subject}, including it if deleted.
        slots:
          version: path.version
          subject: path.subject
      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:
      - Can I delete a single version of a DEK and keep the others?
      - Is a deleted DEK version gone for good, or can it be soft-deleted?
      instructions:
      - text: Delete version {version} of the DEK for {subject} under KEK {name}.
        slots:
          version: path.version
          subject: path.subject
          name: path.name
      - text: Permanently delete DEK version {version} of subject {subject}.
        slots:
          version: path.version
          subject: path.subject
      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 for one subject?
      instructions:
      - text: List DEK versions for subject {subject} under KEK {name}.
        slots:
          subject: path.subject
          name: path.name
      - text: Show the first {limit} DEK versions of {subject} in KEK {name}.
        slots:
          limit: query.limit
          subject: path.subject
          name: path.name
      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 one deleted DEK version
      effect: write
      questions:
      - How do I bring back a single DEK version I soft-deleted?
      - Can one deleted version of a data encryption key be restored?
      instructions:
      - text: Undelete version {version} of the DEK for {subject} under KEK {name}.
        slots:
          version: path.version
          subject: path.subject
          name: path.name
      - text: Restore DEK version {version} of subject {subject}.
        slots:
          version: path.version
          subject: path.subject
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dek-registry/v1/keks/{name}/deks/{subject}/undelete'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore all deleted versions of a DEK
      effect: write
      questions:
      - Can I undelete every soft-deleted version of a subject's DEK in one go?
      - What restores all versions of a data encryption key after a soft delete?
      instructions:
      - text: Undelete all DEK versions for subject {subject} under KEK {name}.
        slots:
          subject: path.subject
          name: path.name
      - text: Restore every deleted {algorithm} DEK version of {subject} in KEK {name}.
        slots:
          algorithm: query.algorithm
          subject: path.subject
          name: path.name
      method: generated
      generated: '2026-09-26'