Cloudflare · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cloudflare Workers Domains API

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

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 Domains API
  version: 1.0.0
extends: openapi/cloudflare-domains-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/domains'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom domains on Workers
      effect: read
      questions:
      - Which custom domains are attached to my Worker scripts?
      - Can I see every hostname that serves a Worker directly?
      instructions:
      - text: List the custom domains attached to Workers in account {account}.
        slots:
          account: path.account_id
      - text: Show all Worker custom domains I've set up.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/workers/domains'].put
  update:
    x-apievangelist-phrasing:
      intent: Attach a custom domain to a Worker
      effect: write
      questions:
      - How do I serve a Worker on my own custom domain?
      - Can I attach a hostname to a Worker script instead of using a route?
      instructions:
      - text: Attach a custom domain to a Worker in account {account}.
        slots:
          account: path.account_id
      - text: Hook up a new custom domain to my Worker script.
      method: generated
      generated: '2026-09-26'