Hint Health · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Partner Endpoints Appointment API

3 actions 3 updates phrasing extends openapi/hint-health-appointment-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/appointment_types'].get
$.paths['/provider/appointments'].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 Partner Endpoints Appointment API
  version: 1.0.0
extends: openapi/hint-health-appointment-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/appointment_types'].get
  update:
    x-apievangelist-phrasing:
      intent: List appointment types
      effect: read
      questions:
      - What kinds of appointments does the practice offer?
      - Are archived or inactive appointment types included in the list?
      instructions:
      - text: List all active appointment types.
      - text: Show {limit} appointment types starting at offset {offset}.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/appointments'].get
  update:
    x-apievangelist-phrasing:
      intent: List appointments
      effect: read
      questions:
      - Which appointments are booked between two dates?
      - Can I see a single patient's upcoming appointments?
      - Are declined appointments returned in the list?
      instructions:
      - text: List appointments from {start_date} to {end_date}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
      - text: Show appointments for patient {patient}.
        slots:
          patient: query.patient
      - text: List appointments with status {status}.
        slots:
          status: query.status
      method: generated
      generated: '2026-10-01'