Hint Health · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Hint Health Practice API

3 actions 3 updates phrasing extends openapi/hint-health-practice-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/practice'].get
$.paths['/provider/practice'].patch

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 Practice API
  version: 1.0.0
extends: openapi/hint-health-practice-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/practice'].get
  update:
    x-apievangelist-phrasing:
      intent: View the practice profile
      effect: read
      questions:
      - Where can I see my practice's name, address and contact details?
      - What information is stored on the practice profile?
      instructions:
      - text: Show my practice profile.
      - text: Get the practice's address, phones and website.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/practice'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update the practice profile
      effect: write
      questions:
      - How do I change my practice's address or phone numbers?
      - Can I update the practice logo and website URL?
      instructions:
      - text: Rename the practice to {name}.
        slots:
          name: requestBody.name
      - text: Set the practice email to {email} and website to {url}.
        slots:
          email: requestBody.email
          url: requestBody.url
      - text: Update the practice address to {address_line1}, {address_city}, {address_state} {address_zip}.
        slots:
          address_line1: requestBody.address_line1
          address_city: requestBody.address_city
          address_state: requestBody.address_state
          address_zip: requestBody.address_zip
      method: generated
      generated: '2026-10-01'