Hint Health · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Partner Endpoints API Key API

3 actions 3 updates phrasing extends openapi/hint-health-api-key-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['/partner/api_keys'].get
$.paths['/partner/api_keys'].post

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 API Key API
  version: 1.0.0
extends: openapi/hint-health-api-key-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['/partner/api_keys'].get
  update:
    x-apievangelist-phrasing:
      intent: List my partner API keys
      effect: read
      questions:
      - Which API keys exist on my partner account?
      - Can I find keys that were deactivated or not used recently?
      instructions:
      - text: List my API keys.
      - text: Find API keys labeled {label}.
        slots:
          label: query.label
      - text: List API keys last used at {last_used_at}.
        slots:
          last_used_at: query.last_used_at
      method: generated
      generated: '2026-10-01'
- target: $.paths['/partner/api_keys'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a partner API key
      effect: write
      questions:
      - How do I generate a new API key for my partner account?
      - Can I see an API key's token again after it is created?
      instructions:
      - text: Create an API key labeled {label}.
        slots:
          label: requestBody.label
      - text: Generate a new partner API key.
      method: generated
      generated: '2026-10-01'