Stedi · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Stedi Events API

4 actions 4 updates phrasing extends openapi/stedi-events-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['/events/{eventId}/retry'].post

$.paths['/events'].get

$.paths['/events/{eventId}'].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 Stedi Events API
  version: 1.0.0
extends: openapi/stedi-events-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['/events/{eventId}/retry'].post
  update:
    x-apievangelist-phrasing:
      intent: Re-send a processing event
      effect: write
      questions:
      - My webhook missed an event -- can I have it sent again?
      - How do I retrigger a specific processing event?
      instructions:
      - text: Retry event {eventId}.
        slots:
          eventId: path.eventId
      - text: Re-emit processing event {eventId} to my destinations.
        slots:
          eventId: path.eventId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events'].get
  update:
    x-apievangelist-phrasing:
      intent: List events
      effect: read
      questions:
      - Which events failed to deliver on my account?
      - Can I list events of one type created after a certain date?
      instructions:
      - text: List my recent events.
      - text: Show events with status {status}.
        slots:
          status: query.status
      - text: List {eventType} events created {created}.
        slots:
          eventType: query.eventType
          created: query.created
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{eventId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an event
      effect: read
      questions:
      - What payload and delivery status does a particular event have?
      - Can I look up one event by its identifier?
      instructions:
      - text: Show event {eventId}.
        slots:
          eventId: path.eventId
      - text: Get the details of event {eventId}.
        slots:
          eventId: path.eventId
      method: generated
      generated: '2026-09-26'