Hint Health · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Hint Health User API

2 actions 2 updates phrasing extends openapi/hint-health-user-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 2

$.info
$.paths['/provider/users'].get

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 User API
  version: 1.0.0
extends: openapi/hint-health-user-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: 1
- target: $.paths['/provider/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List practice users
      effect: read
      questions:
      - Which staff users have access to my practice?
      - Can I page through and sort the list of practice users?
      instructions:
      - text: List the practice's users.
      - text: List {limit} practice users sorted by {sort}.
        slots:
          limit: query.limit
          sort: query.sort
      method: generated
      generated: '2026-10-01'