Hint Health · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Partner Endpoints Installation API

6 actions 6 updates phrasing extends openapi/hint-health-installation-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 6

$.info

$.paths['/partner/installations'].get

$.paths['/partner/installations/connect'].post

$.paths['/partner/installations/{id}'].get

$.paths['/partner/installations/{id}/activate'].post

$.paths['/partner/installations/{id}/deactivate'].post

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 Partner Endpoints Installation API
  version: 1.0.0
extends: openapi/hint-health-installation-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: 5
- target: $.paths['/partner/installations'].get
  update:
    x-apievangelist-phrasing:
      intent: List partner app installations
      effect: read
      questions:
      - Which practices have installed my partner product?
      - Can I filter installations by status or by product?
      - Are deactivated installations included when I list installs?
      instructions:
      - text: List all installations of my products.
      - text: List installations with status {status}.
        slots:
          status: query.status
      - text: Show installations of product {partner_product}.
        slots:
          partner_product: query.partner_product
      method: generated
      generated: '2026-10-01'
- target: $.paths['/partner/installations/connect'].post
  update:
    x-apievangelist-phrasing:
      intent: Exchange an install code for credentials
      effect: write
      questions:
      - How do I turn the authorization code from a practice install into API credentials?
      - What do I get back when I connect a new installation?
      instructions:
      - text: Connect the installation using authorization code {code}.
        slots:
          code: requestBody.code
      - text: Exchange install code {code} for the practice's API credentials.
        slots:
          code: requestBody.code
      method: generated
      generated: '2026-10-01'
- target: $.paths['/partner/installations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one installation
      effect: read
      questions:
      - What practice and product does a specific installation belong to?
      - Can I still view an installation after it was deactivated?
      instructions:
      - text: Show installation {id}.
        slots:
          id: path.id
      - text: Get the current status of installation {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/partner/installations/{id}/activate'].post
  update:
    x-apievangelist-phrasing:
      intent: Activate a pending installation
      effect: write
      questions:
      - How do I activate an installation that is still pending?
      - Does activating an installation also activate the practice connection?
      instructions:
      - text: Activate installation {id}.
        slots:
          id: path.id
      - text: Turn on pending installation {id} for the practice.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/partner/installations/{id}/deactivate'].post
  update:
    x-apievangelist-phrasing:
      intent: Deactivate an installation
      effect: destructive
      questions:
      - Can I deactivate one installation without affecting the practice's other installs?
      - What happens when I deactivate an installation?
      instructions:
      - text: Deactivate installation {id}.
        slots:
          id: path.id
      - text: Switch off installation {id} for that practice.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'