Hint Health · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Hint Health Interaction Notifications API

2 actions 2 updates phrasing extends openapi/hint-health-interactionnotifications-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/interactions/{interaction_id}/notifications'].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 Interaction Notifications API
  version: 1.0.0
extends: openapi/hint-health-interactionnotifications-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/interactions/{interaction_id}/notifications'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a notification about an interaction
      effect: write
      questions:
      - Can I notify the care team about a specific interaction?
      - Is it possible to give an interaction notification a custom title?
      instructions:
      - text: Create a notification for interaction {interaction_id}.
        slots:
          interaction_id: path.interaction_id
      - text: Notify about interaction {interaction_id} with title {title}.
        slots:
          interaction_id: path.interaction_id
          title: requestBody.title
      method: generated
      generated: '2026-10-01'