# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for BigPanda API Keys API
  version: 1.0.0
extends: openapi/bigpanda-api-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: 6
- target: $.paths['/resources/v2.1/apikeys'].get
  update:
    x-apievangelist-phrasing:
      intent: List API keys
      effect: read
      questions:
      - Which API keys exist in my BigPanda organization?
      - Can I audit every API key the org has issued?
      instructions:
      - text: List all API keys for the organization.
      - text: Show every issued API key.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.1/apikeys'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an API key
      effect: write
      questions:
      - How do I generate a new API key for an integration?
      - Can I create an API key tied to a service account with specific roles?
      instructions:
      - text: Create an API key named {name} with description {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      - text: Create key {name} for service account {service_account_id} with roles {roles}.
        slots:
          name: requestBody.name
          service_account_id: requestBody.service_account_id
          roles: requestBody.roles
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.1/apikeys/{apikey_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an API key
      effect: read
      questions:
      - When was a particular API key last used?
      - Can I see who created a specific API key?
      instructions:
      - text: Get API key {apikey_id}.
        slots:
          apikey_id: path.apikey_id
      - text: Show the details and last use of key {apikey_id}.
        slots:
          apikey_id: path.apikey_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.1/apikeys/{apikey_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an API key
      effect: destructive
      questions:
      - How do I revoke an API key that may have leaked?
      - Can I delete an API key by its ID?
      instructions:
      - text: Delete API key {apikey_id}.
        slots:
          apikey_id: path.apikey_id
      - text: Revoke the leaked key {apikey_id}.
        slots:
          apikey_id: path.apikey_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.1/apikeys/{apikey_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an API key's name or expiry
      effect: write
      questions:
      - Can I set an expiration date on an existing API key?
      - How do I rename an API key or move it to another service account?
      instructions:
      - text: Set API key {apikey_id} to expire at {expires_at}.
        slots:
          apikey_id: path.apikey_id
          expires_at: requestBody.expires_at
      - text: Rename key {apikey_id} to {name}.
        slots:
          apikey_id: path.apikey_id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.1/service-accounts/{service_account_id}/api-keys'].get
  update:
    x-apievangelist-phrasing:
      intent: List a service account's API keys
      effect: read
      questions:
      - Which API keys belong to a given service account?
      - Can I list only the keys issued to one service account?
      instructions:
      - text: List API keys for service account {service_account_id}.
        slots:
          service_account_id: path.service_account_id
      - text: Show keys owned by service account {service_account_id}.
        slots:
          service_account_id: path.service_account_id
      method: generated
      generated: '2026-09-26'