Hint Health · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Hint Health Affiliate Patient API

3 actions 3 updates phrasing extends openapi/hint-health-affiliatepatient-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/affiliates/{affiliate_id}/patients'].post
$.paths['/provider/affiliates/{affiliate_id}/patients/{id}'].delete

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 Affiliate Patient API
  version: 1.0.0
extends: openapi/hint-health-affiliatepatient-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/affiliates/{affiliate_id}/patients'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign a patient to an affiliate
      effect: write
      questions:
      - Can I link a patient to an affiliate?
      - What do I need to assign someone to an affiliation?
      instructions:
      - text: Assign patient {patient_id} to affiliate {affiliate_id}.
        slots:
          patient_id: requestBody.patient_id
          affiliate_id: path.affiliate_id
      - text: Add patient {patient_id} under affiliation {affiliate_id}.
        slots:
          patient_id: requestBody.patient_id
          affiliate_id: path.affiliate_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/affiliates/{affiliate_id}/patients/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a patient from an affiliate
      effect: destructive
      questions:
      - Can I take a patient off an affiliation?
      - Is unassigning a patient from an affiliate immediate?
      instructions:
      - text: Remove patient {id} from affiliate {affiliate_id}.
        slots:
          id: path.id
          affiliate_id: path.affiliate_id
      - text: Unassign {id} from affiliation {affiliate_id}.
        slots:
          id: path.id
          affiliate_id: path.affiliate_id
      method: generated
      generated: '2026-10-01'