Hint Health · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Hint Health Employee Division API

2 actions 2 updates phrasing extends openapi/hint-health-employeedivision-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/companies/{company_id}/employee_divisions'].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 Employee Division API
  version: 1.0.0
extends: openapi/hint-health-employeedivision-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/companies/{company_id}/employee_divisions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a company's employee divisions
      effect: read
      questions:
      - What employee divisions does an employer client have?
      - Can I see how a company's workforce is split into divisions?
      instructions:
      - text: List employee divisions for company {company_id}.
        slots:
          company_id: path.company_id
      - text: Show the divisions set up at company {company_id}.
        slots:
          company_id: path.company_id
      method: generated
      generated: '2026-10-01'