Hint Health · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Hint Health Form Response API

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

$.paths['/provider/patients/{patient_id}/form_responses/{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 Form Response API
  version: 1.0.0
extends: openapi/hint-health-form-response-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/patients/{patient_id}/form_responses'].get
  update:
    x-apievangelist-phrasing:
      intent: List a patient's form responses
      effect: read
      questions:
      - What forms has a patient filled out?
      - Can I see every intake form response for one patient?
      instructions:
      - text: List form responses for patient {patient_id}.
        slots:
          patient_id: path.patient_id
      - text: Show all forms submitted by patient {patient_id}.
        slots:
          patient_id: path.patient_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/patients/{patient_id}/form_responses/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one form response
      effect: read
      questions:
      - What answers did a patient give on a specific form?
      - Can I open a single form response by id?
      instructions:
      - text: Show form response {id} for patient {patient_id}.
        slots:
          id: path.id
          patient_id: path.patient_id
      - text: Get the answers on form {id} from patient {patient_id}.
        slots:
          id: path.id
          patient_id: path.patient_id
      method: generated
      generated: '2026-10-01'