Cloudflare · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cloudflare Queues Messages API

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

$.info
$.paths['/accounts/{account_id}/queues/{queue_id}/messages'].post
$.paths['/accounts/{account_id}/queues/{queue_id}/messages/batch'].post
$.paths['/accounts/{account_id}/queues/{queue_id}/messages/pull'].post
$.paths['/accounts/{account_id}/queues/{queue_id}/messages/ack'].post

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 Messages API
  version: 1.0.0
extends: openapi/cloudflare-messages-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: 4
- target: $.paths['/accounts/{account_id}/queues/{queue_id}/messages'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a single message to a queue
      effect: write
      questions:
      - How do I publish one message onto a Cloudflare Queue over HTTP?
      - Can I set the content type of a message I put on a queue?
      instructions:
      - text: Send the message {body} to queue {queue} in account {account}.
        slots:
          body: requestBody.body
          queue: path.queue_id
          account: path.account_id
      - text: Put one {content_type} message {body} on queue {queue} in account {account}.
        slots:
          content_type: requestBody.content_type
          body: requestBody.body
          queue: path.queue_id
          account: path.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/queues/{queue_id}/messages/batch'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a batch of messages to a queue
      effect: write
      questions:
      - Can I push many messages onto a queue in one request?
      - What's the way to enqueue a list of messages at once instead of one by one?
      instructions:
      - text: Send these messages {messages} to queue {queue} in account {account} as a batch.
        slots:
          messages: requestBody.messages
          queue: path.queue_id
          account: path.account_id
      - text: Enqueue the batch {messages} on queue {queue} in account {account}.
        slots:
          messages: requestBody.messages
          queue: path.queue_id
          account: path.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/queues/{queue_id}/messages/pull'].post
  update:
    x-apievangelist-phrasing:
      intent: Pull messages from a queue for processing
      effect: write
      questions:
      - How do I consume messages from a queue with an HTTP pull consumer?
      - Can I hide pulled messages from other consumers while I process them?
      - What limits how many queue messages I get back in one pull?
      instructions:
      - text: Pull up to {batch_size} messages from queue {queue} in account {account}.
        slots:
          batch_size: requestBody.batch_size
          queue: path.queue_id
          account: path.account_id
      - text: Pull messages from queue {queue} in account {account} and keep them hidden for {visibility_timeout_ms} ms.
        slots:
          queue: path.queue_id
          account: path.account_id
          visibility_timeout_ms: requestBody.visibility_timeout_ms
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/queues/{queue_id}/messages/ack'].post
  update:
    x-apievangelist-phrasing:
      intent: Acknowledge or retry pulled queue messages
      effect: destructive
      questions:
      - How do I mark pulled queue messages as done so they're removed?
      - Can I send some pulled messages back for retry instead of acknowledging them?
      instructions:
      - text: Acknowledge messages {acks} on queue {queue} in account {account}.
        slots:
          acks: requestBody.acks
          queue: path.queue_id
          account: path.account_id
      - text: Ack {acks} and retry {retries} on queue {queue} in account {account}.
        slots:
          acks: requestBody.acks
          retries: requestBody.retries
          queue: path.queue_id
          account: path.account_id
      method: generated
      generated: '2026-09-26'