Cloudflare · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cloudflare Queues API

7 actions 7 updates phrasing extends openapi/cloudflare-queues-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 7

$.info
$.paths['/accounts/{account_id}/queues'].get
$.paths['/accounts/{account_id}/queues'].post
$.paths['/accounts/{account_id}/queues/{queue_id}'].get
$.paths['/accounts/{account_id}/queues/{queue_id}'].put
$.paths['/accounts/{account_id}/queues/{queue_id}'].delete
$.paths['/accounts/{account_id}/queues/{queue_id}'].patch

OpenAPI Overlay

Raw ↑
# 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 API
  version: 1.0.0
extends: openapi/cloudflare-queues-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: 6
- target: $.paths['/accounts/{account_id}/queues'].get
  update:
    x-apievangelist-phrasing:
      intent: List all queues in an account
      effect: read
      questions:
      - Which message queues does my Cloudflare account have?
      - Can I see every queue my account owns in one list?
      instructions:
      - text: List all queues in account {account_id}.
        slots:
          account_id: path.account_id
      - text: Show me my message queues.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/queues'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new message queue
      effect: write
      questions:
      - How do I create a new message queue?
      - What do I need to name a queue when I set one up?
      instructions:
      - text: Create a queue named {queue_name} in account {account_id}.
        slots:
          queue_name: requestBody.queue_name
          account_id: path.account_id
      - text: Set up a new message queue called {queue_name}.
        slots:
          queue_name: requestBody.queue_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/queues/{queue_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the details of one queue
      effect: read
      questions:
      - What are the details of a specific queue?
      - Can I look up a single queue by its ID?
      instructions:
      - text: Get queue {queue_id} in account {account_id}.
        slots:
          queue_id: path.queue_id
          account_id: path.account_id
      - text: Show the details for queue {queue_id}.
        slots:
          queue_id: path.queue_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/queues/{queue_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Overwrite a queue's full configuration
      effect: write
      questions:
      - How do I overwrite a queue's whole configuration at once?
      - Can I replace a queue's settings entirely rather than patching them?
      instructions:
      - text: Replace the full configuration of queue {queue_id} in account {account_id}.
        slots:
          queue_id: path.queue_id
          account_id: path.account_id
      - text: Overwrite queue {queue_id}'s configuration with the name {queue_name}.
        slots:
          queue_id: path.queue_id
          queue_name: requestBody.queue_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/queues/{queue_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a queue and its messages
      effect: destructive
      questions:
      - What happens to pending messages when I delete a queue?
      - Can I remove a queue I no longer use?
      instructions:
      - text: Delete queue {queue_id} from account {account_id}.
        slots:
          queue_id: path.queue_id
          account_id: path.account_id
      - text: Remove queue {queue_id} along with all of its messages.
        slots:
          queue_id: path.queue_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/queues/{queue_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update a queue's settings
      effect: write
      questions:
      - Can I rename a queue without resetting its other settings?
      - Is there a way to change just one setting on an existing queue?
      instructions:
      - text: Rename queue {queue_id} to {queue_name}, keeping its other settings.
        slots:
          queue_id: path.queue_id
          queue_name: requestBody.queue_name
      - text: Patch the settings of queue {queue_id} in account {account_id}.
        slots:
          queue_id: path.queue_id
          account_id: path.account_id
      method: generated
      generated: '2026-09-26'