Cloudflare · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cloudflare Hyperdrive Configurations API

6 actions 6 updates phrasing extends openapi/cloudflare-configurations-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['/accounts/{account_id}/hyperdrive/configs'].get
$.paths['/accounts/{account_id}/hyperdrive/configs'].post
$.paths['/accounts/{account_id}/hyperdrive/configs/{config_id}'].get
$.paths['/accounts/{account_id}/hyperdrive/configs/{config_id}'].put
$.paths['/accounts/{account_id}/hyperdrive/configs/{config_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 Hyperdrive Configurations API
  version: 1.0.0
extends: openapi/cloudflare-configurations-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['/accounts/{account_id}/hyperdrive/configs'].get
  update:
    x-apievangelist-phrasing:
      intent: List Hyperdrive configurations
      effect: read
      questions:
      - What Hyperdrive database connections have I set up in my account?
      - How do I see all my Hyperdrive configs at once?
      instructions:
      - text: List all Hyperdrive configurations in account {account}.
        slots:
          account: path.account_id
      - text: Show me every Hyperdrive setup on account {account}.
        slots:
          account: path.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/hyperdrive/configs'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Hyperdrive configuration for a database
      effect: write
      questions:
      - How do I put Hyperdrive in front of my existing Postgres database?
      - Can I configure caching settings when I first set up a Hyperdrive connection?
      instructions:
      - text: Create a Hyperdrive configuration named {name} in account {account} connecting to origin {origin}.
        slots:
          name: requestBody.name
          account: path.account_id
          origin: requestBody.origin
      - text: Set up new Hyperdrive config {name} for origin {origin} in account {account} with caching {caching}.
        slots:
          name: requestBody.name
          origin: requestBody.origin
          account: path.account_id
          caching: requestBody.caching
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/hyperdrive/configs/{config_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Hyperdrive configuration's details
      effect: read
      questions:
      - How can I check the origin and caching settings of one Hyperdrive config?
      - Which database host is a specific Hyperdrive configuration pointing at?
      instructions:
      - text: Show Hyperdrive configuration {config} in account {account}.
        slots:
          config: path.config_id
          account: path.account_id
      - text: Get the connection details of Hyperdrive config {config} in account {account}.
        slots:
          config: path.config_id
          account: path.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/hyperdrive/configs/{config_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a Hyperdrive configuration
      effect: write
      questions:
      - How do I point an existing Hyperdrive config at a new database origin?
      - Can I change caching on a Hyperdrive configuration after it's been created?
      instructions:
      - text: Update Hyperdrive config {config} in account {account} to name {name} and origin {origin}.
        slots:
          config: path.config_id
          account: path.account_id
          name: requestBody.name
          origin: requestBody.origin
      - text: Change caching on existing Hyperdrive config {config} in account {account} to {caching}, keeping name {name} and origin {origin}.
        slots:
          config: path.config_id
          account: path.account_id
          caching: requestBody.caching
          name: requestBody.name
          origin: requestBody.origin
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{account_id}/hyperdrive/configs/{config_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Hyperdrive configuration
      effect: destructive
      questions:
      - How do I remove a Hyperdrive configuration I'm not using anymore?
      - Can I tear down one Hyperdrive connection without affecting the others?
      instructions:
      - text: Delete Hyperdrive configuration {config} from account {account}.
        slots:
          config: path.config_id
          account: path.account_id
      - text: Remove the unused Hyperdrive config {config} in account {account}.
        slots:
          config: path.config_id
          account: path.account_id
      method: generated
      generated: '2026-09-26'