Hint Health · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Hint Health Integration API

6 actions 6 updates phrasing extends openapi/hint-health-integration-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['/integrations/{id}/activate'].post

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

$.paths['/integrations'].get

$.paths['/integrations/{id}'].get

$.paths['/integrations/{id}'].patch

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 Integration API
  version: 1.0.0
extends: openapi/hint-health-integration-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['/integrations/{id}/activate'].post
  update:
    x-apievangelist-phrasing:
      intent: Activate an integration
      effect: write
      questions:
      - Can I activate an integration that is still pending?
      - Can I switch an integration on after the practice connects it?
      instructions:
      - text: Activate integration {id}.
        slots:
          id: path.id
      - text: Turn on integration {id} for the practice.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/integrations/{id}/deactivate'].post
  update:
    x-apievangelist-phrasing:
      intent: Deactivate an integration
      effect: destructive
      questions:
      - Is there a way to deactivate an integration with a practice?
      - Can I switch off an integration without deleting it?
      instructions:
      - text: Deactivate integration {id}.
        slots:
          id: path.id
      - text: Switch off integration {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/integrations'].get
  update:
    x-apievangelist-phrasing:
      intent: List my integrations
      effect: read
      questions:
      - Which practice integrations do I have?
      - How can I see all the integrations my partner account is connected to?
      instructions:
      - text: List all integrations.
      - text: Show every practice integration I have.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/integrations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one integration
      effect: read
      questions:
      - What are the details and status of one integration?
      - Is a specific integration active or pending?
      instructions:
      - text: Show integration {id}.
        slots:
          id: path.id
      - text: Get the status of integration {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/integrations/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Override an integration's webhook URL
      effect: write
      questions:
      - Can I send one integration's webhooks to a different URL than my default?
      - How do I set a webhook URL override on an integration?
      instructions:
      - text: Set the webhook URL override on integration {id} to {webhook_url_override}.
        slots:
          id: path.id
          webhook_url_override: requestBody.webhook_url_override
      - text: Update integration {id} to deliver webhooks to {webhook_url_override}.
        slots:
          id: path.id
          webhook_url_override: requestBody.webhook_url_override
      method: generated
      generated: '2026-10-01'