Cloudflare · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cloudflare Queues Purge API

3 actions 3 updates phrasing extends openapi/cloudflare-purge-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Cloudflare's API. It is a proposal applied on top of the contract, not a document Cloudflare publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/accounts/{account_id}/queues/{queue_id}/purge'].get

$.paths['/accounts/{account_id}/queues/{queue_id}/purge'].post

OpenAPI Overlay

# 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 Purge API
  version: 1.0.0
extends: openapi/cloudflare-purge-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: 2
- target: $.paths['/accounts/{account_id}/queues/{queue_id}/purge'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether a queue purge has finished
      effect: read
      questions:
      - Has my queue purge finished yet?
      - Can I check the progress of clearing a queue?
      instructions:
      - text: Check the purge status of queue {queue_id} in account {account_id}.
        slots:
          queue_id: path.queue_id
          account_id: path.account_id
      - text: Tell me if the purge on {queue_id} is complete.
        slots:
          queue_id: path.queue_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/queues/{queue_id}/purge'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete every message in a queue
      effect: destructive
      questions:
      - How do I clear out all the messages in a queue without deleting it?
      - Can I empty a backed-up queue in one step?
      instructions:
      - text: Purge all messages from queue {queue_id} in account {account_id}.
        slots:
          queue_id: path.queue_id
          account_id: path.account_id
      - text: Empty queue {queue_id} of its messages.
        slots:
          queue_id: path.queue_id
      method: generated
      generated: '2026-09-26'