Stedi · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Core Partnerships API

4 actions 4 updates phrasing extends openapi/stedi-partnerships-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 4

$.info

$.paths['/partnerships/{partnershipId}/transaction-groups/{transactionGroupId}/generate-edi'].post

$.paths['/partnerships/{partnershipId}/transaction-groups/{transactionGroupId}/transactions/{transactionSettingId}'].post

$.paths['/partnerships/{partnershipId}/transactions/{transactionSettingId}'].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 Partnerships API
  version: 1.0.0
extends: openapi/stedi-partnerships-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: 3
- target: $.paths['/partnerships/{partnershipId}/transaction-groups/{transactionGroupId}/generate-edi'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate EDI from a staged transaction group
      effect: write
      questions:
      - Once I've staged several transactions, how do I bundle them into one EDI file for my trading partner?
      - Can I control the order of transactions when generating EDI from a transaction group?
      instructions:
      - text: Generate and deliver EDI for transaction group {transactionGroupId} in partnership {partnershipId}.
        slots:
          transactionGroupId: path.transactionGroupId
          partnershipId: path.partnershipId
      - text: Send staged group {transactionGroupId} to partnership {partnershipId} as file {filename}.
        slots:
          transactionGroupId: path.transactionGroupId
          partnershipId: path.partnershipId
          filename: requestBody.filename
      method: generated
      generated: '2026-09-26'
- target: $.paths['/partnerships/{partnershipId}/transaction-groups/{transactionGroupId}/transactions/{transactionSettingId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Stage a transaction in a transaction group
      effect: write
      questions:
      - How do I queue up outbound transactions so they can be sent together later?
      - Can I upload a staged transaction asynchronously through a presigned URL?
      instructions:
      - text: Stage {transaction} in group {transactionGroupId} for partnership {partnershipId} with setting {transactionSettingId}.
        slots:
          transaction: requestBody.transaction
          transactionGroupId: path.transactionGroupId
          partnershipId: path.partnershipId
          transactionSettingId: path.transactionSettingId
      - text: Add a transaction to group {transactionGroupId} on partnership {partnershipId} (setting {transactionSettingId}) via async upload {async}.
        slots:
          transactionGroupId: path.transactionGroupId
          partnershipId: path.partnershipId
          transactionSettingId: path.transactionSettingId
          async: requestBody.async
      method: generated
      generated: '2026-09-26'
- target: $.paths['/partnerships/{partnershipId}/transactions/{transactionSettingId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a single transaction as an EDI file
      effect: write
      questions:
      - What's the simplest way to send one EDI transaction to a trading partner?
      - Can I generate a single-transaction EDI file from JSON using a mapping?
      instructions:
      - text: Send {transaction} to partnership {partnershipId} using transaction setting {transactionSettingId}.
        slots:
          transaction: requestBody.transaction
          partnershipId: path.partnershipId
          transactionSettingId: path.transactionSettingId
      - text: Generate one EDI file for partnership {partnershipId}, setting {transactionSettingId}, from {transaction} via mapping {mappingId}.
        slots:
          partnershipId: path.partnershipId
          transactionSettingId: path.transactionSettingId
          transaction: requestBody.transaction
          mappingId: requestBody.mappingId
      method: generated
      generated: '2026-09-26'