# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for TextQL v2 Playbooks API
  version: 1.0.0
extends: openapi/textql-playbooks-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['/v2/playbooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List playbooks
      effect: read
      questions:
      - Which scheduled playbooks do I have?
      - Can I filter playbooks by status, like only deployed ones?
      instructions:
      - text: List my playbooks.
      - text: Show playbooks matching {search_term} with status {status}.
        slots:
          search_term: query.search_term
          status: query.status_filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/playbooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an empty playbook
      effect: write
      questions:
      - How do I start a new recurring report playbook?
      - What settings does a brand-new playbook start with?
      instructions:
      - text: Create a new empty playbook.
      - text: Start a blank playbook with default settings.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/playbooks/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a playbook and its recent reports
      effect: read
      questions:
      - How do I see a playbook's configuration and its latest reports?
      - Can I page through older reports a playbook generated?
      instructions:
      - text: Get playbook {id}.
        slots:
          id: path.id
      - text: Show playbook {id} with its last {limit} reports.
        slots:
          id: path.id
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/playbooks/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a playbook
      effect: destructive
      questions:
      - How do I delete a playbook I no longer need?
      - Can I permanently remove a scheduled report?
      instructions:
      - text: Delete playbook {id}.
        slots:
          id: path.id
      - text: Remove the scheduled playbook {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/playbooks/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a playbook's prompt, schedule or delivery
      effect: write
      questions:
      - How do I change when a playbook runs?
      - Can a playbook send its report to email addresses and a Slack channel?
      - Which connectors and datasets can I point a playbook at?
      instructions:
      - text: Set the prompt of playbook {id} to {prompt}.
        slots:
          id: path.id
          prompt: requestBody.prompt
      - text: Schedule playbook {id} on cron {cron}.
        slots:
          id: path.id
          cron: requestBody.cron_string
      - text: Deliver playbook {id} reports to {emails} and Slack channel {channel}.
        slots:
          id: path.id
          emails: requestBody.email_addresses
          channel: requestBody.slack_channel_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/playbooks/{id}/deploy'].post
  update:
    x-apievangelist-phrasing:
      intent: Deploy a playbook to its schedule
      effect: write
      questions:
      - How do I activate a playbook so it runs on schedule?
      - What makes a draft playbook go live?
      instructions:
      - text: Deploy playbook {id}.
        slots:
          id: path.id
      - text: Activate playbook {id} on its schedule.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/playbooks/{id}/run'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a playbook now
      effect: write
      questions:
      - Can I run a playbook immediately and get the report back?
      - Is there a dry run to validate a playbook without executing it?
      instructions:
      - text: Run playbook {id} now.
        slots:
          id: path.id
      - text: Run playbook {id} with dry run set to {dry_run}.
        slots:
          id: path.id
          dry_run: requestBody.dry_run
      method: generated
      generated: '2026-10-01'