Cloudflare · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cloudflare Workers Scripts API

5 actions 5 updates phrasing extends openapi/cloudflare-scripts-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}/workers/scripts'].get
$.paths['/accounts/{account_id}/workers/scripts/{script_name}'].get
$.paths['/accounts/{account_id}/workers/scripts/{script_name}'].put
$.paths['/accounts/{account_id}/workers/scripts/{script_name}'].delete

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 Scripts API
  version: 1.0.0
extends: openapi/cloudflare-scripts-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}/workers/scripts'].get
  update:
    x-apievangelist-phrasing:
      intent: List all Worker scripts in an account
      effect: read
      questions:
      - Which Worker scripts are uploaded to my account?
      - Can I get a list of every Worker script by name?
      instructions:
      - text: List the Worker scripts in account {account_id}.
        slots:
          account_id: path.account_id
      - text: Show me all my uploaded Worker scripts.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/workers/scripts/{script_name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a Worker script's code
      effect: read
      questions:
      - How do I download the code of a deployed Worker script?
      - Can I get back the source content of a Worker by name?
      instructions:
      - text: Download the code of Worker script {script_name} in account {account_id}.
        slots:
          script_name: path.script_name
          account_id: path.account_id
      - text: Fetch the script content for {script_name}.
        slots:
          script_name: path.script_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/workers/scripts/{script_name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Upload or update a Worker script
      effect: write
      questions:
      - What's the way to push new code to a Worker script by name?
      - Can I upload a Worker script as base64-encoded JSON instead of multipart?
      instructions:
      - text: Upload new code to Worker script {script_name} in account {account_id}.
        slots:
          script_name: path.script_name
          account_id: path.account_id
      - text: Publish this code as the Worker script {script_name}.
        slots:
          script_name: path.script_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/workers/scripts/{script_name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Worker script
      effect: destructive
      questions:
      - Can I delete a Worker script by its name?
      - What's needed to remove an old Worker script?
      instructions:
      - text: Delete Worker script {script_name} from account {account_id}.
        slots:
          script_name: path.script_name
          account_id: path.account_id
      - text: Remove the {script_name} script.
        slots:
          script_name: path.script_name
      method: generated
      generated: '2026-09-26'