Vital · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Junction Order Transaction API

4 actions 4 updates phrasing extends openapi/vital-io-order-transaction-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 4

$.info
$.paths['/v3/order_transaction/{transaction_id}'].get
$.paths['/v3/order_transaction/{transaction_id}/result'].get
$.paths['/v3/order_transaction/{transaction_id}/result/pdf'].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 Order Transaction API
  version: 1.0.0
extends: openapi/vital-io-order-transaction-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: 3
- target: $.paths['/v3/order_transaction/{transaction_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an order transaction
      effect: read
      questions:
      - What orders belong to an order transaction?
      - Can I check the status of a whole order transaction?
      instructions:
      - text: Get order transaction {tx}.
        slots:
          tx: path.transaction_id
      - text: Show the orders and status in transaction {tx}.
        slots:
          tx: path.transaction_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/order_transaction/{transaction_id}/result'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an order transaction's results
      effect: read
      questions:
      - Can I get combined results for every order in a transaction?
      - Where do I get structured result data for an order transaction?
      instructions:
      - text: Get results for transaction {tx}.
        slots:
          tx: path.transaction_id
      - text: Fetch the combined result data of transaction {tx}.
        slots:
          tx: path.transaction_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/order_transaction/{transaction_id}/result/pdf'].get
  update:
    x-apievangelist-phrasing:
      intent: Download an order transaction's results PDF
      effect: read
      questions:
      - Can I download a PDF of an order transaction's results?
      - Is there a printable report covering a full transaction?
      instructions:
      - text: Download the results PDF for transaction {tx}.
        slots:
          tx: path.transaction_id
      - text: Get transaction {tx}'s result report as a PDF.
        slots:
          tx: path.transaction_id
      method: generated
      generated: '2026-10-01'