Cloudflare · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cloudflare Workers Deployments API

3 actions 3 updates phrasing extends openapi/cloudflare-deployments-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}/workers/scripts/{script_name}/deployments'].get

$.paths['/accounts/{account_id}/workers/scripts/{script_name}/deployments'].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 Workers Deployments API
  version: 1.0.0
extends: openapi/cloudflare-deployments-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}/workers/scripts/{script_name}/deployments'].get
  update:
    x-apievangelist-phrasing:
      intent: List a Worker script's deployments
      effect: read
      questions:
      - What deployments has my Worker script had?
      - Can I see which versions a Worker has been deployed with?
      instructions:
      - text: List the deployments of Worker script {script_name} in account {account_id}.
        slots:
          script_name: path.script_name
          account_id: path.account_id
      - text: Show the deployment history for {script_name}.
        slots:
          script_name: path.script_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/workers/scripts/{script_name}/deployments'].post
  update:
    x-apievangelist-phrasing:
      intent: Deploy a Worker version to take traffic
      effect: write
      questions:
      - How do I send traffic to a specific version of my Worker?
      - Can I roll a Worker forward by creating a new deployment?
      instructions:
      - text: Create a new deployment for Worker script {script_name} in account {account_id}.
        slots:
          script_name: path.script_name
          account_id: path.account_id
      - text: Point {script_name}'s traffic at a specific version with a new deployment.
        slots:
          script_name: path.script_name
      method: generated
      generated: '2026-09-26'