Vital · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Junction Lab Tests API
12 actions
12 updates
phrasing
extends
openapi/vital-io-lab-tests-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.
What the actions change
x-apievangelist-phrasing
Targets 12
$.info
$.paths['/v3/lab_tests'].get
$.paths['/v3/lab_tests'].post
$.paths['/v3/lab_tests/{lab_test_id}'].get
$.paths['/v3/lab_tests/{lab_test_id}'].patch
$.paths['/v3/lab_tests/markers'].get
$.paths['/v3/lab_tests/list_order_set_markers'].post
$.paths['/v3/lab_tests/{lab_test_id}/markers'].get
$.paths['/v3/lab_tests/{lab_id}/markers/{provider_id}'].get
$.paths['/v3/lab_tests/labs'].get
$.paths['/v3/lab_test'].get
$.paths['/v3/lab_test/{lab_test_id}/collection_instruction_pdf'].get
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 Lab Tests API
version: 1.0.0
extends: openapi/vital-io-lab-tests-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: 11
- target: $.paths['/v3/lab_tests'].get
update:
x-apievangelist-phrasing:
intent: List all lab tests my team can order
effect: read
questions:
- What lab tests can my team order?
- Can I filter my team's full lab test list by lab or collection method?
instructions:
- text: List all my team's lab tests at lab {lab_slug}.
slots:
lab_slug: query.lab_slug
- text: Show every lab test using collection method {collection_method}, sorted by {order_key}.
slots:
collection_method: query.collection_method
order_key: query.order_key
method: generated
generated: '2026-10-01'
- target: $.paths['/v3/lab_tests'].post
update:
x-apievangelist-phrasing:
intent: Create a custom lab test
effect: write
questions:
- Can I build my own lab test panel from a set of markers?
- Is it possible to mark a new lab test as requiring fasting?
instructions:
- text: Create lab test {name} with markers {marker_ids}, collected by {method}, described as {description}.
slots:
name: requestBody.name
marker_ids: requestBody.marker_ids
method: requestBody.method
description: requestBody.description
- text: Create a fasting lab test {name} via {method} at lab {body_lab_slug}, described as {description}.
slots:
name: requestBody.name
method: requestBody.method
body_lab_slug: requestBody.lab_slug
description: requestBody.description
method: generated
generated: '2026-10-01'
- target: $.paths['/v3/lab_tests/{lab_test_id}'].get
update:
x-apievangelist-phrasing:
intent: Get one lab test
effect: read
questions:
- What's included in one specific lab test my team has?
- Can I view a single lab test's details under a particular lab account?
instructions:
- text: Get lab test {lab_test_id}.
slots:
lab_test_id: path.lab_test_id
- text: Show lab test {lab_test_id} as seen under lab account {lab_account_id}.
slots:
lab_test_id: path.lab_test_id
lab_account_id: query.lab_account_id
method: generated
generated: '2026-10-01'
- target: $.paths['/v3/lab_tests/{lab_test_id}'].patch
update:
x-apievangelist-phrasing:
intent: Rename or deactivate a lab test
effect: write
questions:
- Can I rename a lab test after creating it?
- How do I switch a lab test to inactive?
instructions:
- text: Rename lab test {lab_test_id} to {name}.
slots:
lab_test_id: path.lab_test_id
name: requestBody.name
- text: Set lab test {lab_test_id} active to {active}.
slots:
lab_test_id: path.lab_test_id
active: requestBody.active
method: generated
generated: '2026-10-01'
- target: $.paths['/v3/lab_tests/markers'].get
update:
x-apievangelist-phrasing:
intent: List orderable markers at a lab
effect: read
questions:
- Which biomarkers can I order from a particular lab?
- Can I find just the a la carte markers a lab offers?
instructions:
- text: List orderable markers at lab {lab_slug}.
slots:
lab_slug: query.lab_slug
- text: Search lab {lab_id} for markers named {marker_name}.
slots:
lab_id: query.lab_id
marker_name: query.name
method: generated
generated: '2026-10-01'
- target: $.paths['/v3/lab_tests/list_order_set_markers'].post
update:
x-apievangelist-phrasing:
intent: List markers for an order set
effect: read
questions:
- What markers would an order set of several lab tests plus add-ons include?
- Can I preview the combined markers for multiple lab tests before ordering?
instructions:
- text: List the markers for lab tests {lab_test_ids} with add-ons {add_on}.
slots:
lab_test_ids: requestBody.lab_test_ids
add_on: requestBody.add_on
- text: Show combined markers for order set tests {lab_test_ids}.
slots:
lab_test_ids: requestBody.lab_test_ids
method: generated
generated: '2026-10-01'
- target: $.paths['/v3/lab_tests/{lab_test_id}/markers'].get
update:
x-apievangelist-phrasing:
intent: List a lab test's markers and reflexes
effect: read
questions:
- Which markers, including reflex markers, does a lab test cover?
- Can I page through the biomarkers inside one lab test?
instructions:
- text: List the markers in lab test {lab_test_id}.
slots:
lab_test_id: path.lab_test_id
- text: Show page {page} of markers and reflex markers for test {lab_test_id}.
slots:
page: query.page
lab_test_id: path.lab_test_id
method: generated
generated: '2026-10-01'
- target: $.paths['/v3/lab_tests/{lab_id}/markers/{provider_id}'].get
update:
x-apievangelist-phrasing:
intent: Look up a marker by a lab's provider ID
effect: read
questions:
- Can I look up a marker using the lab's own test code?
- What marker does a lab's provider ID correspond to?
instructions:
- text: Get marker {provider_id} at lab {path_lab_id}.
slots:
provider_id: path.provider_id
path_lab_id: path.lab_id
- text: Look up the marker with provider ID {provider_id} at lab {path_lab_id} for account {lab_account_id}.
slots:
provider_id: path.provider_id
path_lab_id: path.lab_id
lab_account_id: query.lab_account_id
method: generated
generated: '2026-10-01'
- target: $.paths['/v3/lab_tests/labs'].get
update:
x-apievangelist-phrasing:
intent: List all labs
effect: read
questions:
- Which labs are available for testing?
- What labs can I choose from when building a lab test?
instructions:
- text: List all labs.
- text: Show me every lab I can send tests to.
method: generated
generated: '2026-10-01'
- target: $.paths['/v3/lab_test'].get
update:
x-apievangelist-phrasing:
intent: Page through my team's lab tests
effect: read
questions:
- Can I page through lab tests with a cursor instead of getting them all at once?
- Is there a paginated lab test list with a page size limit?
instructions:
- text: Get the next {lab_test_limit} lab tests after cursor {next_cursor}.
slots:
lab_test_limit: query.lab_test_limit
next_cursor: query.next_cursor
- text: Page through my team's lab tests filtered by status {status}.
slots:
status: query.status
method: generated
generated: '2026-10-01'
- target: $.paths['/v3/lab_test/{lab_test_id}/collection_instruction_pdf'].get
update:
x-apievangelist-phrasing:
intent: Get a lab test's collection instructions
effect: read
questions:
- Where can I get the sample collection instructions PDF for a lab test?
- Does each lab test have printable collection instructions?
instructions:
- text: Get the collection instructions PDF for lab test {lab_test_id}.
slots:
lab_test_id: path.lab_test_id
- text: Download collection instructions for test {lab_test_id}.
slots:
lab_test_id: path.lab_test_id
method: generated
generated: '2026-10-01'