Hint Health · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Hint Health Supplements API

6 actions 6 updates phrasing extends openapi/hint-health-supplements-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/patients/{patient_id}/supplements'].get

$.paths['/provider/patients/{patient_id}/supplements'].post

$.paths['/provider/patients/{patient_id}/supplements/{id}'].get

$.paths['/provider/patients/{patient_id}/supplements/{id}'].delete

$.paths['/provider/patients/{patient_id}/supplements/{id}'].patch

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 Supplements API
  version: 1.0.0
extends: openapi/hint-health-supplements-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/patients/{patient_id}/supplements'].get
  update:
    x-apievangelist-phrasing:
      intent: List a patient's supplements
      effect: read
      questions:
      - What supplements is a patient currently taking?
      - Can I page through a long supplement list for one patient?
      instructions:
      - text: List supplements for patient {patient_id}.
        slots:
          patient_id: path.patient_id
      - text: Show {limit} supplements for patient {patient_id} from offset {offset}.
        slots:
          limit: query.limit
          patient_id: path.patient_id
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/patients/{patient_id}/supplements'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a supplement for a patient
      effect: write
      questions:
      - How do I add a supplement to a patient's record?
      - Can I include the strength and dosing directions for a supplement?
      instructions:
      - text: Add supplement {product_name} for patient {patient_id}.
        slots:
          product_name: requestBody.product_name
          patient_id: path.patient_id
      - text: Record {product_name} {strength} {strength_uom} for patient {patient_id} with directions {sig_text}.
        slots:
          product_name: requestBody.product_name
          strength: requestBody.strength
          strength_uom: requestBody.strength_uom
          patient_id: path.patient_id
          sig_text: requestBody.sig_text
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/patients/{patient_id}/supplements/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one patient supplement
      effect: read
      questions:
      - What dose is recorded for a specific supplement on a patient?
      - Can I view a single supplement entry for a patient?
      instructions:
      - text: Show supplement {id} for patient {patient_id}.
        slots:
          id: path.id
          patient_id: path.patient_id
      - text: Get the dosing details of supplement {id} on patient {patient_id}.
        slots:
          id: path.id
          patient_id: path.patient_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/patients/{patient_id}/supplements/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a patient supplement
      effect: destructive
      questions:
      - Can I remove a supplement the patient stopped taking?
      - Is deleting a supplement entry permanent?
      instructions:
      - text: Delete supplement {id} from patient {patient_id}.
        slots:
          id: path.id
          patient_id: path.patient_id
      - text: Remove the supplement {id} on patient {patient_id}'s record.
        slots:
          id: path.id
          patient_id: path.patient_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/patients/{patient_id}/supplements/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a patient supplement
      effect: write
      questions:
      - Can I change the dose of a supplement already on a patient's record?
      - Is it possible to edit the directions for an existing supplement?
      instructions:
      - text: Change supplement {id} on patient {patient_id} to strength {strength} {strength_uom}.
        slots:
          id: path.id
          patient_id: path.patient_id
          strength: requestBody.strength
          strength_uom: requestBody.strength_uom
      - text: Update the quantity of supplement {id} for patient {patient_id} to {quantity}.
        slots:
          id: path.id
          patient_id: path.patient_id
          quantity: requestBody.quantity
      method: generated
      generated: '2026-10-01'