Cloudflare · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cloudflare Workers API

7 actions 7 updates phrasing extends openapi/cloudflare-workers-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}/workers/workers'].get
$.paths['/accounts/{account_id}/workers/workers'].post
$.paths['/accounts/{account_id}/workers/workers/{worker_id}'].get
$.paths['/accounts/{account_id}/workers/workers/{worker_id}'].put
$.paths['/accounts/{account_id}/workers/workers/{worker_id}'].delete
$.paths['/accounts/{account_id}/workers/workers/{worker_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 Workers API
  version: 1.0.0
extends: openapi/cloudflare-workers-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}/workers/workers'].get
  update:
    x-apievangelist-phrasing:
      intent: List all Workers in an account
      effect: read
      questions:
      - Which Workers are deployed in my Cloudflare account?
      - Can I page through every Worker my account has?
      instructions:
      - text: List all Workers in account {account_id}.
        slots:
          account_id: path.account_id
      - text: Show me every Worker I have.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/workers/workers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new Worker
      effect: write
      questions:
      - How do I create a new Worker with a name and entry module?
      - What do I need to provide to set up a brand-new Worker?
      instructions:
      - text: Create a Worker named {name} in account {account_id}.
        slots:
          name: requestBody.name
          account_id: path.account_id
      - text: Set up a new Worker {name} with {main_module} as its entry point.
        slots:
          name: requestBody.name
          main_module: requestBody.main_module
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/workers/workers/{worker_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the details of one Worker
      effect: read
      questions:
      - What are the details of a particular Worker?
      - Can I look up a Worker by its ID to check its entry module?
      instructions:
      - text: Get Worker {worker_id} in account {account_id}.
        slots:
          worker_id: path.worker_id
          account_id: path.account_id
      - text: Show the details of Worker {worker_id}.
        slots:
          worker_id: path.worker_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/workers/workers/{worker_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace all of a Worker's properties
      effect: write
      questions:
      - How do I fully replace a Worker's properties in one request?
      - Does a full Worker replacement reset fields I leave out?
      instructions:
      - text: Replace all properties of Worker {worker_id} in account {account_id}.
        slots:
          worker_id: path.worker_id
          account_id: path.account_id
      - text: Overwrite Worker {worker_id} with name {name} and entry module {main_module}.
        slots:
          worker_id: path.worker_id
          name: requestBody.name
          main_module: requestBody.main_module
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/workers/workers/{worker_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Worker and its resources
      effect: destructive
      questions:
      - Can I delete a Worker along with everything attached to it?
      - What gets removed when a Worker is deleted?
      instructions:
      - text: Delete Worker {worker_id} from account {account_id}.
        slots:
          worker_id: path.worker_id
          account_id: path.account_id
      - text: Remove Worker {worker_id} and all its associated resources.
        slots:
          worker_id: path.worker_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/workers/workers/{worker_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit some of a Worker's fields
      effect: write
      questions:
      - Can I rename a Worker without touching its other fields?
      - Is there a way to change only a Worker's entry module?
      instructions:
      - text: Rename Worker {worker_id} to {name}, leaving other fields unchanged.
        slots:
          worker_id: path.worker_id
          name: requestBody.name
      - text: Change just the entry module of Worker {worker_id} in account {account_id} to {main_module}.
        slots:
          worker_id: path.worker_id
          account_id: path.account_id
          main_module: requestBody.main_module
      method: generated
      generated: '2026-09-26'