Hint Health · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Hint Health Lead Source API

5 actions 5 updates phrasing extends openapi/hint-health-lead-source-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 5

$.info
$.paths['/provider/lead_sources/{id}'].delete
$.paths['/provider/lead_sources/{id}'].patch
$.paths['/provider/lead_sources'].get
$.paths['/provider/lead_sources'].post

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 Lead Source API
  version: 1.0.0
extends: openapi/hint-health-lead-source-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: 4
- target: $.paths['/provider/lead_sources/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a lead source
      effect: destructive
      questions:
      - Can I remove a referral source we no longer track?
      - Is deleting a lead source permanent?
      instructions:
      - text: Delete lead source {id}.
        slots:
          id: path.id
      - text: Remove the lead source {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/lead_sources/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename a lead source
      effect: write
      questions:
      - Can I rename an existing lead source?
      - Is it possible to fix a typo in a lead source name?
      instructions:
      - text: Rename lead source {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Fix the name of existing lead source {id} so it reads {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/lead_sources'].get
  update:
    x-apievangelist-phrasing:
      intent: List lead sources
      effect: read
      questions:
      - Which lead sources are configured for tracking where patients come from?
      - What referral channels has the practice set up?
      instructions:
      - text: List all lead sources.
      - text: Show every referral channel the practice tracks.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/lead_sources'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a lead source
      effect: write
      questions:
      - Can I add a new lead source for a marketing campaign?
      - What do I need to set up a new referral channel?
      instructions:
      - text: Create a lead source named {name}.
        slots:
          name: requestBody.name
      - text: Add {name} as a new lead source.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-10-01'