Stedi · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Core Polling API

3 actions 3 updates phrasing extends openapi/stedi-polling-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 3

$.info

$.paths['/polling/executions'].get

$.paths['/polling/transactions'].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 Core Polling API
  version: 1.0.0
extends: openapi/stedi-polling-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: 2
- target: $.paths['/polling/executions'].get
  update:
    x-apievangelist-phrasing:
      intent: Poll for newly processed file executions
      effect: read
      questions:
      - How can I check for new EDI files Stedi has processed without using webhooks?
      - Can I poll for file executions processed since a given time?
      instructions:
      - text: Poll for file executions processed since {startDateTime}.
        slots:
          startDateTime: query.startDateTime
      - text: Check for newly processed files.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/polling/transactions'].get
  update:
    x-apievangelist-phrasing:
      intent: Poll for newly processed transactions
      effect: read
      questions:
      - Is there a way to poll for new transactions instead of receiving events?
      - Which transactions were processed after a certain time?
      instructions:
      - text: Poll for transactions processed since {startDateTime}.
        slots:
          startDateTime: query.startDateTime
      - text: Check for newly processed transactions.
      method: generated
      generated: '2026-09-26'