Hint Health · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Hint Health Company Plan API

5 actions 5 updates phrasing extends openapi/hint-health-companyplan-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['/provider/companies/{company_id}/company_plans'].get

$.paths['/provider/companies/{company_id}/company_plans'].post

$.paths['/provider/companies/{company_id}/company_plans/{id}'].delete

$.paths['/provider/companies/{company_id}/company_plans/{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 Company Plan API
  version: 1.0.0
extends: openapi/hint-health-companyplan-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['/provider/companies/{company_id}/company_plans'].get
  update:
    x-apievangelist-phrasing:
      intent: List plans offered to a company
      effect: read
      questions:
      - Which membership plans are offered to an employer company?
      - What plans can a company's employees enroll in?
      instructions:
      - text: List the plans for company {company_id}.
        slots:
          company_id: path.company_id
      - text: Show every company plan offered at company {company_id}.
        slots:
          company_id: path.company_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/companies/{company_id}/company_plans'].post
  update:
    x-apievangelist-phrasing:
      intent: Offer a plan to a company
      effect: write
      questions:
      - Can I make a membership plan available to an employer company?
      - Can I add a plan to a company but keep it closed to enrollment?
      instructions:
      - text: Add plan {plan} to company {company_id}, available for enrollment {available_for_enrollment}.
        slots:
          plan: requestBody.plan
          company_id: path.company_id
          available_for_enrollment: requestBody.available_for_enrollment
      - text: Offer plan {plan} at company {company_id} with enrollment open set to {available_for_enrollment}.
        slots:
          plan: requestBody.plan
          company_id: path.company_id
          available_for_enrollment: requestBody.available_for_enrollment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/companies/{company_id}/company_plans/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a plan from a company
      effect: destructive
      questions:
      - Is there a way to stop offering a plan to an employer company?
      - Can I delete a company plan?
      instructions:
      - text: Remove company plan {id} from company {company_id}.
        slots:
          id: path.id
          company_id: path.company_id
      - text: Delete plan offering {id} at company {company_id}.
        slots:
          id: path.id
          company_id: path.company_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/companies/{company_id}/company_plans/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Open or close a company plan to enrollment
      effect: write
      questions:
      - How do I close enrollment on a plan a company already offers?
      - Can I reopen a company plan for new enrollments?
      instructions:
      - text: Set company plan {id} at company {company_id} available for enrollment to {available_for_enrollment}.
        slots:
          id: path.id
          company_id: path.company_id
          available_for_enrollment: requestBody.available_for_enrollment
      - text: Close enrollment on company plan {id} for company {company_id}.
        slots:
          id: path.id
          company_id: path.company_id
      method: generated
      generated: '2026-10-01'