Hint Health · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Hint Health Partner Charge API

4 actions 4 updates phrasing extends openapi/hint-health-partnercharge-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 4

$.info

$.paths['/provider/partner_charges'].get

$.paths['/provider/partner_charges'].post

$.paths['/provider/partner_charges/{id}'].get

OpenAPI Overlay

# 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 Partner Charge API
  version: 1.0.0
extends: openapi/hint-health-partnercharge-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: 3
- target: $.paths['/provider/partner_charges'].get
  update:
    x-apievangelist-phrasing:
      intent: List partner charges
      effect: read
      questions:
      - What charges have partners billed through the practice?
      - Can I see all partner charges in one list?
      instructions:
      - text: List all partner charges.
      - text: Show every charge submitted by partners.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/partner_charges'].post
  update:
    x-apievangelist-phrasing:
      intent: Bill a partner charge
      effect: write
      questions:
      - Can a partner charge be billed to either the patient or the practice?
      - How do I submit a charge for a partner service?
      instructions:
      - text: Create a partner charge of {amount_in_cents} cents for {description} with record {integration_record_id}.
        slots:
          amount_in_cents: requestBody.amount_in_cents
          description: requestBody.description
          integration_record_id: requestBody.integration_record_id
      - text: Charge patient {patient} {amount_in_cents} cents for {description}, record {integration_record_id}.
        slots:
          patient: requestBody.patient
          amount_in_cents: requestBody.amount_in_cents
          description: requestBody.description
          integration_record_id: requestBody.integration_record_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/partner_charges/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a partner charge
      effect: read
      questions:
      - What are the details of a specific partner charge?
      - Who was billed for a particular partner charge?
      instructions:
      - text: Show partner charge {id}.
        slots:
          id: path.id
      - text: Get the amount and payer for partner charge {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'