Hint Health · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Hint Health Charge Item API

6 actions 6 updates phrasing extends openapi/hint-health-chargeitem-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Hint Health's API. It is a proposal applied on top of the contract, not a document Hint Health publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/provider/charge_items'].get
$.paths['/provider/charge_items'].post
$.paths['/provider/charge_items/{id}'].get
$.paths['/provider/charge_items/{id}'].delete
$.paths['/provider/charge_items/{id}'].patch

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 Hint Health Charge Item API
  version: 1.0.0
extends: openapi/hint-health-chargeitem-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: 5
- target: $.paths['/provider/charge_items'].get
  update:
    x-apievangelist-phrasing:
      intent: List charge items
      effect: read
      questions:
      - What billable items and services does my practice have set up?
      - Can I see stock levels for charge items that track inventory?
      instructions:
      - text: List all charge items.
      - text: Show every product and service in the charge item catalog.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/charge_items'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a charge item
      effect: write
      questions:
      - How do I add a new billable product or service to my catalog?
      - What fields are required when setting up a charge item?
      instructions:
      - text: Create a charge item {name} priced at {price_in_cents} cents of type {type}.
        slots:
          name: requestBody.name
          price_in_cents: requestBody.price_in_cents
          type: requestBody.type
      - text: Add {name} to the catalog as a {type} for {price_in_cents} cents with description {description}.
        slots:
          name: requestBody.name
          type: requestBody.type
          price_in_cents: requestBody.price_in_cents
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/charge_items/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a charge item
      effect: read
      questions:
      - What is the current price of a specific charge item?
      - How many units of a given charge item are left in stock?
      instructions:
      - text: Show charge item {id}.
        slots:
          id: path.id
      - text: Get the price and stock for charge item {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/charge_items/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a charge item
      effect: destructive
      questions:
      - Can I remove a service we no longer offer from the catalog?
      - Is deleting a charge item permanent?
      instructions:
      - text: Delete charge item {id}.
        slots:
          id: path.id
      - text: Remove charge item {id} from the catalog.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/charge_items/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a charge item
      effect: write
      questions:
      - Can I change the price of an existing charge item?
      - Is it possible to rename a product already in my catalog?
      instructions:
      - text: Update charge item {id} to {name} at {price_in_cents} cents, type {type}.
        slots:
          id: path.id
          name: requestBody.name
          price_in_cents: requestBody.price_in_cents
          type: requestBody.type
      - text: Reprice charge item {id} ({name}, {type}) to {price_in_cents} cents with description {description}.
        slots:
          id: path.id
          name: requestBody.name
          type: requestBody.type
          price_in_cents: requestBody.price_in_cents
          description: requestBody.description
      method: generated
      generated: '2026-10-01'