Stedi · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Core Fragments API

2 actions 2 updates phrasing extends openapi/stedi-fragments-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['/fragments/{fragmentGroupId}'].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 Fragments API
  version: 1.0.0
extends: openapi/stedi-fragments-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['/fragments/{fragmentGroupId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Stage an EDI fragment for outbound delivery
      effect: write
      questions:
      - How do I build a large outbound EDI transaction piece by piece using fragments?
      - Can I transform a fragment with a mapping before it is staged?
      instructions:
      - text: Stage {fragment} in fragment group {fragmentGroupId} using guide {guideId}.
        slots:
          fragment: requestBody.fragment
          fragmentGroupId: path.fragmentGroupId
          guideId: requestBody.guideId
      - text: Add a fragment to group {fragmentGroupId} for guide {guideId} and run mapping {mappingId} on it.
        slots:
          fragmentGroupId: path.fragmentGroupId
          guideId: requestBody.guideId
          mappingId: requestBody.mappingId
      method: generated
      generated: '2026-09-26'