Vital · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Junction Compendium API

3 actions 3 updates phrasing extends openapi/vital-io-compendium-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Vital's API. It is a proposal applied on top of the contract, not a document Vital publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/v3/compendium/search'].post

$.paths['/v3/compendium/convert'].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 Junction Compendium API
  version: 1.0.0
extends: openapi/vital-io-compendium-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['/v3/compendium/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search the lab test compendium
      effect: read
      questions:
      - Can I find orderable lab tests in the compendium by CPT code?
      - Which compendium entries match a test name across several labs?
      instructions:
      - text: Search the compendium in {mode} mode for {query}.
        slots:
          mode: requestBody.mode
          query: requestBody.query
      - text: Look up compendium entries for CPT codes {cpt_codes} at labs {labs}, returning at most {limit}.
        slots:
          cpt_codes: requestBody.cpt_codes
          labs: requestBody.labs
          limit: requestBody.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/compendium/convert'].post
  update:
    x-apievangelist-phrasing:
      intent: Convert a lab test to another lab's equivalent
      effect: read
      questions:
      - Can I map a lab test to the equivalent orderable tests at a different lab?
      - Which tests at a target lab correspond to the lab provider IDs I already use?
      instructions:
      - text: Convert lab test {lab_test} to its equivalent at {target_lab}.
        slots:
          lab_test: requestBody.lab_test_id
          target_lab: requestBody.target_lab
      - text: Map provider IDs {provider_ids} onto the {target_lab} compendium.
        slots:
          provider_ids: requestBody.provider_ids
          target_lab: requestBody.target_lab
      method: generated
      generated: '2026-10-01'