API Evangelist conversational phrasing for Live Direct Marketing Online Tracking / Bot List API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Live Direct Marketing Online Tracking / Bot List API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-tracking-bot-list-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: 6
- target: $.paths['/api/bot-list'].get
  update:
    x-apievangelist-phrasing:
      intent: Get global bot-list stats
      effect: read
      questions:
      - How many bot feeds and custom IP ranges are on the global bot list?
      - When was the click-tracking bot list last refreshed?
      instructions:
      - text: Show the global bot-list stats.
      - text: Report the bot feed count, custom entries and last refresh time.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/bot-list/refresh'].post
  update:
    x-apievangelist-phrasing:
      intent: Reload external bot feeds now
      effect: write
      questions:
      - Can I force the bot feeds to reload instead of waiting for the schedule?
      - How do I pull the latest external bot lists into the matcher right away?
      instructions:
      - text: Refresh the external bot feeds now.
      - text: Reload the bot-list matcher from its feeds immediately.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/bot-list/cidr'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an IP range to the global bot list
      effect: write
      questions:
      - How do I flag clicks from a whole IP range as bot traffic?
      - Can I add a custom CIDR so those clicks go to the decoy URL?
      instructions:
      - text: Add a custom bot CIDR to the global bot list.
      - text: Mark an IP range as bots for every tenant's split-cloaked links.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/bot-list/cidr'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an IP range from the global bot list
      effect: destructive
      questions:
      - How do I stop treating an IP range as bot traffic?
      - Can I take a custom CIDR back off the bot list?
      instructions:
      - text: Remove a custom bot CIDR from the global bot list.
      - text: Delete an IP range from the custom bot entries.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/bot-list/ua'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a user-agent pattern to the bot list
      effect: write
      questions:
      - Can I mark clicks from a specific crawler's user agent as bots?
      - How do I add a user-agent regex to the global bot list?
      instructions:
      - text: Add a custom bot user-agent regex to the global bot list.
      - text: Treat a scanner's user agent as a bot across all tenants.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/bot-list/ua'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a user-agent pattern from the bot list
      effect: destructive
      questions:
      - How do I unflag a user agent I previously marked as a bot?
      - Can I delete a custom user-agent regex from the bot list?
      instructions:
      - text: Remove a custom bot user-agent regex from the global bot list.
      - text: Stop treating a user-agent pattern as a bot.
      method: generated
      generated: '2026-10-01'