Hint Health · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Hint Health Coupon API

3 actions 3 updates phrasing extends openapi/hint-health-coupon-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/coupons'].get

$.paths['/provider/coupons/{id}'].get

OpenAPI Overlay

# 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 Coupon API
  version: 1.0.0
extends: openapi/hint-health-coupon-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/coupons'].get
  update:
    x-apievangelist-phrasing:
      intent: List the practice's coupons
      effect: read
      questions:
      - Which coupons does my practice offer?
      - Can I list only coupons that are still redeemable, or only archived ones?
      instructions:
      - text: List all coupons.
      - text: List coupons where redeemable is {redeemable}.
        slots:
          redeemable: query.redeemable
      - text: Show coupons with archived set to {archived}.
        slots:
          archived: query.archived
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/coupons/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one coupon
      effect: read
      questions:
      - How do I look up the details of a specific coupon?
      - What discount does a particular coupon give?
      instructions:
      - text: Show coupon {id}.
        slots:
          id: path.id
      - text: Get the details of coupon {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'