Hint Health · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Hint Health Invoice API

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

$.info
$.paths['/provider/companies/{company_id}/invoices'].get
$.paths['/provider/companies/{company_id}/invoices/{id}'].get

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 Invoice API
  version: 1.0.0
extends: openapi/hint-health-invoice-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: 2
- target: $.paths['/provider/companies/{company_id}/invoices'].get
  update:
    x-apievangelist-phrasing:
      intent: List an employer company's invoices
      effect: read
      questions:
      - Which invoices have been issued to an employer company?
      - Can I see all of a company's invoices at once?
      instructions:
      - text: List invoices for company {company_id}.
        slots:
          company_id: path.company_id
      - text: Show every invoice billed to company {company_id}.
        slots:
          company_id: path.company_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/companies/{company_id}/invoices/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one company invoice
      effect: read
      questions:
      - How do I look up a single invoice for a company?
      - What is the balance on a specific company invoice?
      instructions:
      - text: Show invoice {id} for company {company_id}.
        slots:
          id: path.id
          company_id: path.company_id
      - text: Get company {company_id}'s invoice {id}.
        slots:
          id: path.id
          company_id: path.company_id
      method: generated
      generated: '2026-10-01'