Hint Health · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Hint Health Signup Attempt API

3 actions 3 updates phrasing extends openapi/hint-health-signupattempt-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/signup_attempts'].get
$.paths['/provider/signup_attempts/{id}'].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 Signup Attempt API
  version: 1.0.0
extends: openapi/hint-health-signupattempt-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/signup_attempts'].get
  update:
    x-apievangelist-phrasing:
      intent: List signup attempts
      effect: read
      questions:
      - Who started signing up online but did not finish?
      - Can I filter signup attempts by signup page or lead source?
      instructions:
      - text: List signup attempts with status {status}.
        slots:
          status: query.status
      - text: Show signup attempts from signup page {signup_page}.
        slots:
          signup_page: query.signup_page
      - text: List signup attempts from lead source {lead_source}.
        slots:
          lead_source: query.lead_source
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/signup_attempts/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a signup attempt
      effect: read
      questions:
      - What details were captured on a specific signup attempt?
      - Can I see how far one person got in the signup flow?
      instructions:
      - text: Show signup attempt {id}.
        slots:
          id: path.id
      - text: Get the progress of signup attempt {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'