# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Khoros Ai Registrations API
  version: 1.0.0
extends: openapi/khoros-ai-registrations-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 7
- target: $.paths['/registrations'].get
  update:
    x-apievangelist-phrasing:
      intent: List all bot registrations
      effect: read
      questions:
      - Which bots are registered with the Automation Framework?
      - How do I see every bot registration my token can access?
      instructions:
      - text: List all bot registrations.
      - text: Show every registered bot.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/registrations'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a bot registration
      effect: write
      questions:
      - Can I change the settings of a bot that is already registered?
      - How do I update a bot's registration payload?
      instructions:
      - text: Update the bot registration with payload {payload}.
        slots:
          payload: requestBody.RAW_BODY
      - text: 'Edit my existing bot registration to use these settings: {payload}.'
        slots:
          payload: requestBody.RAW_BODY
      method: generated
      generated: '2026-10-01'
- target: $.paths['/registrations'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a bot with Khoros Care
      effect: write
      questions:
      - How do I register a new bot with Khoros Care and the Automation Framework?
      - What does a new bot registration payload need?
      instructions:
      - text: Register a new bot using payload {payload}.
        slots:
          payload: requestBody.RAW_BODY
      - text: Sign up my bot with the Automation Framework with {payload}.
        slots:
          payload: requestBody.RAW_BODY
      method: generated
      generated: '2026-10-01'
- target: $.paths['/registrations/network/{networkKey}/externalId/{externalId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List bot registrations for a source channel
      effect: read
      questions:
      - Which bots are registered on one network channel?
      - Can I find bot registrations by network and external ID?
      instructions:
      - text: List bot registrations on network {network} for external ID {external}.
        slots:
          network: path.networkKey
          external: path.externalId
      - text: Show all bots registered to channel {external} on {network}.
        slots:
          network: path.networkKey
          external: path.externalId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/registrations/network/{networkKey}/externalId/{externalId}/appId/{appId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one bot registration's details
      effect: read
      questions:
      - How do I see the details of a single bot registration by its app ID?
      - What mode and settings does a specific registered bot have?
      instructions:
      - text: Get the registration for bot app {app} on network {network} with external ID {external}.
        slots:
          app: path.appId
          network: path.networkKey
          external: path.externalId
      - text: Show details of bot {app} registered to {external} on {network}.
        slots:
          app: path.appId
          network: path.networkKey
          external: path.externalId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/registrations/network/{networkKey}/externalId/{externalId}/appId/{appId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a bot registration
      effect: destructive
      questions:
      - How do I unregister a bot from the Automation Framework?
      - Can I delete a bot registration for one channel?
      instructions:
      - text: Delete the registration for bot app {app} on network {network} with external ID {external}.
        slots:
          app: path.appId
          network: path.networkKey
          external: path.externalId
      - text: Unregister bot {app} from channel {external} on {network}.
        slots:
          app: path.appId
          network: path.networkKey
          external: path.externalId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/registrations/network/{networkKey}/externalId/{externalId}/appId/{appId}/mode/{mode}'].put
  update:
    x-apievangelist-phrasing:
      intent: Switch a bot between live and maintenance mode
      effect: write
      questions:
      - Can I put a bot into maintenance mode while I update it?
      - How do I switch a bot back to LIVE mode?
      instructions:
      - text: Set bot {app} on network {network} with external ID {external} to {mode} mode.
        slots:
          app: path.appId
          network: path.networkKey
          external: path.externalId
          mode: path.mode
      - text: Put bot {app} for channel {external} on {network} into {mode}.
        slots:
          app: path.appId
          network: path.networkKey
          external: path.externalId
          mode: path.mode
      method: generated
      generated: '2026-10-01'