Stedi · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Core X12 API

2 actions 2 updates phrasing extends openapi/stedi-x12-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/x12/partnerships/{partnershipId}/generate-edi'].post

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 Core X12 API
  version: 1.0.0
extends: openapi/stedi-x12-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/x12/partnerships/{partnershipId}/generate-edi'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate and deliver EDI to a trading partner
      effect: write
      questions:
      - How do I turn JSON transaction data into X12 EDI and send it to a trading partner?
      - Can I generate several transaction groups into one EDI file?
      - Is it possible to override the interchange usage indicator when generating EDI?
      instructions:
      - text: Generate EDI for partnership {partnershipId} from {transactionGroups}.
        slots:
          partnershipId: path.partnershipId
          transactionGroups: requestBody.transactionGroups
      - text: Send {transactionGroups} to partnership {partnershipId} as file {filename}.
        slots:
          transactionGroups: requestBody.transactionGroups
          partnershipId: path.partnershipId
          filename: requestBody.filename
      - text: Generate EDI for partnership {partnershipId} from {transactionGroups} with usage indicator {interchangeUsageIndicatorOverride}.
        slots:
          partnershipId: path.partnershipId
          transactionGroups: requestBody.transactionGroups
          interchangeUsageIndicatorOverride: requestBody.interchangeUsageIndicatorOverride
      method: generated
      generated: '2026-09-26'