Vital · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Junction Lab Report API

3 actions 3 updates phrasing extends openapi/vital-io-lab-report-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['/lab_report/v1/parser/job'].post
$.paths['/lab_report/v1/parser/job/{job_id}'].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 Lab Report API
  version: 1.0.0
extends: openapi/vital-io-lab-report-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['/lab_report/v1/parser/job'].post
  update:
    x-apievangelist-phrasing:
      intent: Parse an uploaded lab report
      effect: write
      questions:
      - Can I upload a lab report file and have the results extracted?
      - Is human review available when parsing an uploaded lab report?
      instructions:
      - text: Parse lab report {file} for user {user}.
        slots:
          file: requestBody.file
          user: requestBody.user_id
      - text: Upload {file} for {user} and set human review to {needs_review}.
        slots:
          file: requestBody.file
          user: requestBody.user_id
          needs_review: requestBody.needs_human_review
      method: generated
      generated: '2026-10-01'
- target: $.paths['/lab_report/v1/parser/job/{job_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a lab report parse job
      effect: read
      questions:
      - Has my lab report parse job finished, and what did it extract?
      - Where do I get the parsed results once the parser job completes?
      instructions:
      - text: Get parse job {job_id} status and results.
        slots:
          job_id: path.job_id
      - text: Check whether lab report job {job_id} is done.
        slots:
          job_id: path.job_id
      method: generated
      generated: '2026-10-01'