TaskHawk Systems · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Taskhawktech Com Billing API

8 actions 8 updates phrasing extends openapi/taskhawktech-com-billing-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for TaskHawk Systems's API. It is a proposal applied on top of the contract, not a document TaskHawk Systems publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info
$.paths['/payment/discovery'].get
$.paths['/payment/discovery'].head
$.paths['/payment/badge'].get
$.paths['/payment/badge'].head
$.paths['/payment/quote'].get
$.paths['/payment/health'].get
$.paths['/payment/health'].head

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 Taskhawktech Com Billing API
  version: 1.0.0
extends: openapi/taskhawktech-com-billing-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 7
- target: $.paths['/payment/discovery'].get
  update:
    x-apievangelist-phrasing:
      intent: Get payment rail status and all endpoint prices
      effect: read
      questions:
      - Can I get rail health and the price of every paid endpoint in one call?
      - What does each paid TaskHawk endpoint cost across the available payment rails?
      - Is there a way to poll pricing cheaply and only get a body when prices change?
      instructions:
      - text: Fetch the full payment discovery bundle with rail health and every endpoint quote.
      - text: Pull the combined pricing and rail discovery response so I can budget paid calls at startup.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/payment/discovery'].head
  update:
    x-apievangelist-phrasing:
      intent: Check payment discovery headers without a body
      effect: read
      questions:
      - Can I send a HEAD request to the payment discovery endpoint to see if pricing changed?
      - How can I read just the discovery response headers without downloading the quotes?
      instructions:
      - text: Send a HEAD request to payment discovery and report the headers only.
      - text: Check the payment discovery endpoint's headers without fetching the quote bundle.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/payment/badge'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a compact payment rail status badge
      effect: read
      questions:
      - Is there a Shields.io badge showing how many payment rails are configured?
      - Can I embed a one-line rail status like 3/5 rails configured in my README?
      instructions:
      - text: Get the payment rail badge as a one-line count of configured rails.
      - text: Fetch the Shields.io JSON badge for payment rail configuration.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/payment/badge'].head
  update:
    x-apievangelist-phrasing:
      intent: Check the payment badge headers without a body
      effect: read
      questions:
      - Can I HEAD the payment badge endpoint to confirm it is reachable?
      - What headers does the rail status badge return without its body?
      instructions:
      - text: Send a HEAD request to the payment badge endpoint and show the headers.
      - text: Check that the rail status badge responds, headers only.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/payment/quote'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the per-rail price for one endpoint
      effect: read
      questions:
      - How much will a single call to a specific paid endpoint cost on each rail?
      - Can I price one endpoint before calling it, without hitting a 402 first?
      instructions:
      - text: Quote the price of calling {endpoint} on every payment rail.
        slots:
          endpoint: query.endpoint
      - text: Tell me what {endpoint} costs before I make a paid call to it.
        slots:
          endpoint: query.endpoint
      method: generated
      generated: '2026-10-01'
- target: $.paths['/payment/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check which payment rails are configured
      effect: read
      questions:
      - Which payment rails are enabled right now, and why are any disabled?
      - How do I check rail configuration before attempting a payment?
      - Can I run a deep probe of payment backend connectivity with an admin key?
      instructions:
      - text: Show the per-rail payment configuration status with reasons for disabled rails.
      - text: Run a deep backend connectivity check on payment rails using admin key {admin_key}.
        slots:
          admin_key: header.X-Admin-Key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/payment/health'].head
  update:
    x-apievangelist-phrasing:
      intent: Check payment health headers without a body
      effect: read
      questions:
      - Can I send a HEAD request to payment health just to see if it responds?
      - What headers does the payment rail health check return without its per-rail detail?
      instructions:
      - text: Send a HEAD request to payment health and report the status and headers.
      - text: Check payment health reachability with HEAD, deep probe set to {deep}.
        slots:
          deep: query.deep
      method: generated
      generated: '2026-10-01'