Lightfield · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Reference Workflow Run API

2 actions 2 updates phrasing extends openapi/lightfield-workflow-run-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/v1/workflowRun/{runId}/status'].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 Reference Workflow Run API
  version: 1.0.0
extends: openapi/lightfield-workflow-run-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['/v1/workflowRun/{runId}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a workflow run's status
      effect: read
      questions:
      - How do I find out whether a workflow run has finished?
      - What is the current state of a particular workflow run?
      instructions:
      - text: Get the status of workflow run {runId}.
        slots:
          runId: path.runId
      - text: Check whether workflow run {runId} is done.
        slots:
          runId: path.runId
      method: generated
      generated: '2026-10-01'