Hint Health · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Hint Health Practitioner API

6 actions 6 updates phrasing extends openapi/hint-health-practitioner-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/practitioners'].get

$.paths['/provider/practitioners'].post

$.paths['/provider/practitioners/{id}'].get

$.paths['/provider/practitioners/{id}'].delete

$.paths['/provider/practitioners/{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 Practitioner API
  version: 1.0.0
extends: openapi/hint-health-practitioner-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/practitioners'].get
  update:
    x-apievangelist-phrasing:
      intent: List practitioners
      effect: read
      questions:
      - Which practitioners work at the practice?
      - Can I find practitioners near a particular zip code?
      instructions:
      - text: List all practitioners.
      - text: Find practitioners within {distance} of zip {near_zip}.
        slots:
          distance: query.distance
          near_zip: query.near_zip
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/practitioners'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a practitioner
      effect: write
      questions:
      - How do I add a new doctor or clinician to the practice?
      - Can I include a practitioner's NPI and bio when adding them?
      instructions:
      - text: Create a practitioner named {name} with email {email}.
        slots:
          name: requestBody.name
          email: requestBody.email
      - text: Add practitioner {name} with NPI {npi}.
        slots:
          name: requestBody.name
          npi: requestBody.npi
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/practitioners/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a practitioner
      effect: read
      questions:
      - What is a specific practitioner's bio and education?
      - Can I retrieve one practitioner's profile by id?
      instructions:
      - text: Show practitioner {id}.
        slots:
          id: path.id
      - text: Get the profile of practitioner {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/practitioners/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a practitioner
      effect: destructive
      questions:
      - Can I remove a practitioner who has left the practice?
      - Is deleting a practitioner record permanent?
      instructions:
      - text: Delete practitioner {id}.
        slots:
          id: path.id
      - text: Remove practitioner {id} from the practice.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/practitioners/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a practitioner
      effect: write
      questions:
      - Can I update a practitioner's bio or photo?
      - Is it possible to change the NPI on an existing practitioner?
      instructions:
      - text: Update practitioner {id} with bio {bio}.
        slots:
          id: path.id
          bio: requestBody.bio
      - text: Change the email for practitioner {id} to {email}.
        slots:
          id: path.id
          email: requestBody.email
      method: generated
      generated: '2026-10-01'