# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harness Keys API
  version: 1.0.0
extends: openapi/harness-keys-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: 4
- target: $.paths['/ng/api/keys'].get
  update:
    x-apievangelist-phrasing:
      intent: List SSH and PGP keys
      effect: read
      questions:
      - Which SSH and PGP keys are stored in my account?
      - Can I find a key by its fingerprint?
      instructions:
      - text: List keys with scheme {scheme} in account {account}.
        slots:
          scheme: query.keyScheme
          account: query.accountIdentifier
      - text: Find the key with fingerprint {fingerprint}.
        slots:
          fingerprint: query.fingerprint
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/keys'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an SSH or PGP key
      effect: write
      questions:
      - How do I add a PGP key instead of the default SSH key?
      - Can I set a validity window when registering a key?
      instructions:
      - text: Create an SSH key {name} with identifier {identifier} in account {account}.
        slots:
          name: requestBody.name
          identifier: requestBody.identifier
          account: query.accountIdentifier
      - text: Add PGP key {name} with key material {key}, scheme {scheme}.
        slots:
          name: requestBody.name
          key: requestBody.key
          scheme: query.keyScheme
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/keys/{identifier}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a key's validity or revoke it
      effect: destructive
      questions:
      - How do I revoke a compromised PGP key?
      - Can I extend the expiry date of an existing key?
      instructions:
      - text: Revoke key {key_id} with reason {reason}.
        slots:
          key_id: path.identifier
          reason: requestBody.revocationReason
      - text: Set key {key_id} valid until {valid_to} under parent {parent}.
        slots:
          key_id: path.identifier
          valid_to: requestBody.validTo
          parent: query.parentIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/keys/{identifier}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an SSH or PGP key
      effect: destructive
      questions:
      - Can I delete a key I no longer use?
      - Are subkeys removed when I delete a PGP primary key?
      instructions:
      - text: Delete key {key_id} under parent {parent}.
        slots:
          key_id: path.identifier
          parent: query.parentIdentifier
      - text: Remove key {key_id} from account {account}.
        slots:
          key_id: path.identifier
          account: query.accountIdentifier
      method: generated
      generated: '2026-09-26'