Cloudflare · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cloudflare Workers Routes API

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

$.info
$.paths['/zones/{zone_id}/workers/routes'].get
$.paths['/zones/{zone_id}/workers/routes'].post
$.paths['/zones/{zone_id}/workers/routes/{route_id}'].get
$.paths['/zones/{zone_id}/workers/routes/{route_id}'].put
$.paths['/zones/{zone_id}/workers/routes/{route_id}'].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 Routes API
  version: 1.0.0
extends: openapi/cloudflare-routes-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: 5
- target: $.paths['/zones/{zone_id}/workers/routes'].get
  update:
    x-apievangelist-phrasing:
      intent: List a zone's Worker routes
      effect: read
      questions:
      - Which URL patterns on my domain are routed to Workers?
      - Can I see every Worker route configured for a zone?
      instructions:
      - text: List the Worker routes for zone {zone}.
        slots:
          zone: path.zone_id
      - text: Show all URL patterns mapped to Worker scripts on zone {zone}.
        slots:
          zone: path.zone_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/zones/{zone_id}/workers/routes'].post
  update:
    x-apievangelist-phrasing:
      intent: Map a URL pattern to a Worker
      effect: write
      questions:
      - How do I make a Worker run on a URL pattern like example.com/*?
      - Can I add a new route to a zone that invokes a specific Worker script?
      instructions:
      - text: Create a Worker route on zone {zone} for pattern {pattern} running script {script}.
        slots:
          zone: path.zone_id
          pattern: requestBody.pattern
          script: requestBody.script
      - text: Add a new route {pattern} to zone {zone}.
        slots:
          pattern: requestBody.pattern
          zone: path.zone_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/zones/{zone_id}/workers/routes/{route_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Worker route's details
      effect: read
      questions:
      - What pattern and script does a specific Worker route use?
      - Can I look up one Worker route by its ID?
      instructions:
      - text: Get Worker route {route} on zone {zone}.
        slots:
          route: path.route_id
          zone: path.zone_id
      - text: Show which script Worker route {route} invokes.
        slots:
          route: path.route_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/zones/{zone_id}/workers/routes/{route_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a Worker route's pattern or script
      effect: write
      questions:
      - How do I point an existing Worker route at a different script?
      - Can I edit the URL pattern of a route I already created?
      instructions:
      - text: Update Worker route {route} on zone {zone} to use pattern {pattern}.
        slots:
          route: path.route_id
          zone: path.zone_id
          pattern: requestBody.pattern
      - text: Reassign existing route {route} with pattern {pattern} to script {script}.
        slots:
          route: path.route_id
          pattern: requestBody.pattern
          script: requestBody.script
      method: generated
      generated: '2026-09-26'
- target: $.paths['/zones/{zone_id}/workers/routes/{route_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a Worker route
      effect: destructive
      questions:
      - How do I stop a Worker from running on a URL pattern?
      - Can I delete a single Worker route from my zone?
      instructions:
      - text: Delete Worker route {route} from zone {zone}.
        slots:
          route: path.route_id
          zone: path.zone_id
      - text: Remove route {route} so its Worker no longer runs.
        slots:
          route: path.route_id
      method: generated
      generated: '2026-09-26'