Hint Health · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Partner Endpoints Installation API Keys API

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

$.info
$.paths['/partner/installations/{installation_id}/api_keys'].get
$.paths['/partner/installations/{installation_id}/api_keys'].post
$.paths['/partner/installations/{installation_id}/api_keys/{id}'].delete
$.paths['/partner/installations/{installation_id}/api_keys/{id}'].patch

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 Partner Endpoints Installation API Keys API
  version: 1.0.0
extends: openapi/hint-health-installationapikeys-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: 4
- target: $.paths['/partner/installations/{installation_id}/api_keys'].get
  update:
    x-apievangelist-phrasing:
      intent: List an installation's API keys
      effect: read
      questions:
      - Which API keys exist for an installation's practice connection?
      - Can I see when each installation API key was last used?
      instructions:
      - text: List API keys for installation {installation_id}.
        slots:
          installation_id: path.installation_id
      - text: Show API keys labelled {label} on installation {installation_id}.
        slots:
          label: query.label
          installation_id: path.installation_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/partner/installations/{installation_id}/api_keys'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an API key for an installation
      effect: write
      questions:
      - How do I generate a new API key for an installation?
      - Can I retrieve the full token of an installation API key later?
      instructions:
      - text: Create an API key for installation {installation_id}.
        slots:
          installation_id: path.installation_id
      - text: Generate a new key labelled {label} for installation {installation_id}.
        slots:
          label: requestBody.label
          installation_id: path.installation_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/partner/installations/{installation_id}/api_keys/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an installation API key
      effect: destructive
      questions:
      - Can I revoke a leaked API key on an installation?
      - Does deleting an installation key affect other installs from the same practice?
      instructions:
      - text: Delete API key {id} on installation {installation_id}.
        slots:
          id: path.id
          installation_id: path.installation_id
      - text: Revoke key {id} for installation {installation_id}.
        slots:
          id: path.id
          installation_id: path.installation_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/partner/installations/{installation_id}/api_keys/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Relabel an installation API key
      effect: write
      questions:
      - Can I rename the label on an existing installation API key?
      - Is the label the only thing I can change on an installation key?
      instructions:
      - text: Relabel API key {id} on installation {installation_id} as {label}.
        slots:
          id: path.id
          installation_id: path.installation_id
          label: requestBody.label
      - text: Change the label on existing key {id} for installation {installation_id} to {label}.
        slots:
          id: path.id
          installation_id: path.installation_id
          label: requestBody.label
      method: generated
      generated: '2026-10-01'