Cloudflare · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cloudflare Workers Secrets API

3 actions 3 updates phrasing extends openapi/cloudflare-secrets-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}/secrets'].get
$.paths['/accounts/{account_id}/workers/scripts/{script_name}/secrets'].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 Secrets API
  version: 1.0.0
extends: openapi/cloudflare-secrets-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}/secrets'].get
  update:
    x-apievangelist-phrasing:
      intent: List a Worker's secrets
      effect: read
      questions:
      - Which secrets are set on my Worker script?
      - Can I see the names of a Worker's secrets without exposing their values?
      instructions:
      - text: List the secrets on Worker {script_name}.
        slots:
          script_name: path.script_name
      - text: Show secret names for script {script_name} in account {account}.
        slots:
          script_name: path.script_name
          account: path.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/workers/scripts/{script_name}/secrets'].put
  update:
    x-apievangelist-phrasing:
      intent: Add or update a Worker secret
      effect: write
      questions:
      - How do I store an API key as an encrypted secret for my Worker?
      - Can I overwrite the value of a Worker secret that already exists?
      instructions:
      - text: Add secret {name} with value {text} to Worker {script_name}.
        slots:
          name: requestBody.name
          text: requestBody.text
          script_name: path.script_name
      - text: Set {type} secret {name} on script {script_name} in account {account} to {text}.
        slots:
          account: path.account_id
          type: requestBody.type
          name: requestBody.name
          script_name: path.script_name
          text: requestBody.text
      method: generated
      generated: '2026-09-26'