# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Close Playbooks API
  version: 1.0.0
extends: openapi/close-playbooks-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: 7
- target: $.paths['/playbook/'].get
  update:
    x-apievangelist-phrasing:
      intent: List call playbooks
      effect: read
      questions:
      - Which call playbooks does our team have?
      - Can I list only archived playbooks?
      instructions:
      - text: List our playbooks.
      - text: Show playbooks where archived is {is_archived}.
        slots:
          is_archived: query.is_archived
      method: generated
      generated: '2026-09-26'
- target: $.paths['/playbook/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a call playbook
      effect: write
      questions:
      - How do I create a playbook with outcomes and custom fields?
      - Can a playbook include AI summary guidance?
      instructions:
      - text: Create a playbook named {name}.
        slots:
          name: requestBody.name
      - text: Create playbook {name} described as {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/playbook/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single playbook
      effect: read
      questions:
      - What outcomes and fields are in a specific playbook?
      - Where do I see one playbook's full setup?
      instructions:
      - text: Show playbook {id}.
        slots:
          id: path.id
      - text: Fetch the configuration of playbook {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/playbook/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a playbook
      effect: write
      questions:
      - Can I change which outcomes a playbook uses?
      - How do I rename an existing playbook?
      instructions:
      - text: Rename playbook {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Set the summary guidance on playbook {id} to {summary_guidance}.
        slots:
          id: path.id
          summary_guidance: requestBody.summary_guidance
      method: generated
      generated: '2026-09-26'
- target: $.paths['/playbook/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a playbook
      effect: destructive
      questions:
      - Is deleting a playbook different from archiving it?
      - Can I permanently get rid of a playbook?
      instructions:
      - text: Delete playbook {id}.
        slots:
          id: path.id
      - text: Permanently remove playbook {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/playbook/{id}/archive/'].post
  update:
    x-apievangelist-phrasing:
      intent: Archive a playbook
      effect: write
      questions:
      - Does archiving a playbook keep its history?
      - How do I hide an old playbook from the active list?
      instructions:
      - text: Archive playbook {id}.
        slots:
          id: path.id
      - text: Hide playbook {id} from active listings by archiving it.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/playbook/{id}/unarchive/'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore an archived playbook
      effect: write
      questions:
      - Can I bring back a playbook I archived?
      - What's the way to reactivate an archived playbook?
      instructions:
      - text: Unarchive playbook {id}.
        slots:
          id: path.id
      - text: Restore archived playbook {id} to active.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'