# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cloudflare Queues Consumers API
  version: 1.0.0
extends: openapi/cloudflare-consumers-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: 5
- target: $.paths['/accounts/{account_id}/queues/{queue_id}/consumers'].get
  update:
    x-apievangelist-phrasing:
      intent: List a queue's consumers
      effect: read
      questions:
      - Which consumers are reading messages from my Cloudflare queue?
      - Can I see every Worker attached as a consumer to one queue?
      instructions:
      - text: List the consumers configured for queue {queue}.
        slots:
          queue: path.queue_id
      - text: Show all consumers on queue {queue} in account {account}.
        slots:
          queue: path.queue_id
          account: path.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/queues/{queue_id}/consumers'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a consumer to a queue
      effect: write
      questions:
      - How do I attach a Worker to a queue so it processes the messages?
      - Can I add a second consumer to a queue that already has one?
      instructions:
      - text: Add Worker {script_name} as a new consumer on queue {queue}.
        slots:
          script_name: requestBody.script_name
          queue: path.queue_id
      - text: Create a consumer for queue {queue} in account {account} with settings {settings}.
        slots:
          account: path.account_id
          queue: path.queue_id
          settings: requestBody.settings
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/queues/{queue_id}/consumers/{consumer_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a queue consumer's details
      effect: read
      questions:
      - What settings does one particular queue consumer use?
      - Can I check which Worker script a given consumer runs?
      instructions:
      - text: Get consumer {consumer} on queue {queue}.
        slots:
          consumer: path.consumer_id
          queue: path.queue_id
      - text: Show the details of queue consumer {consumer} in account {account}, queue {queue}.
        slots:
          consumer: path.consumer_id
          account: path.account_id
          queue: path.queue_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/queues/{queue_id}/consumers/{consumer_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a queue consumer's configuration
      effect: write
      questions:
      - How do I change the settings of an existing queue consumer?
      - Can I point an existing consumer at a different Worker script?
      instructions:
      - text: Replace consumer {consumer} on queue {queue} so it runs Worker {script_name}.
        slots:
          consumer: path.consumer_id
          queue: path.queue_id
          script_name: requestBody.script_name
      - text: Overwrite the settings of consumer {consumer} on queue {queue} in account {account} with {settings}.
        slots:
          account: path.account_id
          consumer: path.consumer_id
          queue: path.queue_id
          settings: requestBody.settings
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/queues/{queue_id}/consumers/{consumer_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a consumer from a queue
      effect: destructive
      questions:
      - How do I detach a Worker consumer from a queue?
      - Will messages stop being processed if I delete a queue's consumer?
      instructions:
      - text: Remove consumer {consumer} from queue {queue}.
        slots:
          consumer: path.consumer_id
          queue: path.queue_id
      - text: Delete queue consumer {consumer} in account {account} from queue {queue}.
        slots:
          consumer: path.consumer_id
          account: path.account_id
          queue: path.queue_id
      method: generated
      generated: '2026-09-26'