Vital · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Junction Orders API

2 actions 2 updates phrasing extends openapi/vital-io-orders-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 2

$.info
$.paths['/v3/orders'].get

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 Junction Orders API
  version: 1.0.0
extends: openapi/vital-io-orders-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: 1
- target: $.paths['/v3/orders'].get
  update:
    x-apievangelist-phrasing:
      intent: List and filter lab orders
      effect: read
      questions:
      - Can I list lab orders filtered by status and date range?
      - Which orders have critical results?
      - Can I search orders by patient name?
      instructions:
      - text: List orders with status {status} from {start_date} to {end_date}.
        slots:
          status: query.status
          start_date: query.start_date
          end_date: query.end_date
      - text: Find orders for patient {patient_name}.
        slots:
          patient_name: query.patient_name
      - text: Show orders for user {user} where critical is {is_critical}.
        slots:
          user: query.user_id
          is_critical: query.is_critical
      method: generated
      generated: '2026-10-01'