Stedi · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Stedi Event Destinations API

5 actions 5 updates update extends openapi/stedi-event-destinations-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-apievangelistx-authenticationx-conventionsx-testingx-events

Targets 1

$.info

OpenAPI Overlay

overlay: 1.0.0
info:
  title: API Evangelist enhancements for Stedi Event Destinations API
  version: 1.0.0
extends: openapi/stedi-event-destinations-api-openapi.yml
x-generated: '2026-08-15'
x-method: generated
x-source: openapi/stedi-event-destinations-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist:
      catalog: https://apis.io/stedi
      provider: Stedi
      maintainer: Kin Lane <kin@apievangelist.com>
      artifacts:
      - apis.yml
      - vocabulary/stedi-vocabulary.yml
      - rules/stedi-jsonschema-spectral-rules.yml
      - conformance/stedi-conformance.yml
      - conventions/stedi-conventions.yml
      - errors/stedi-problem-types.yml
      - lifecycle/stedi-lifecycle.yml
      - changelog/stedi-changelog.yml
      - packages/stedi-packages.yml
      - mcp/stedi-mcp.yml
      - mcp/stedi-tool-crosswalk.yml
      - authentication/stedi-authentication.yml
      - scopes/stedi-scopes.yml
      - sandbox/stedi-sandbox.yml
      - data-model/stedi-data-model.yml
      - asyncapi/stedi-event-destinations-asyncapi.yml
      - plans/stedi-plans-pricing.yml
      - rate-limits/stedi-rate-limits.yml
      - security/stedi-domain-security.yml
      - skills/_index.yml
- target: $.info
  update:
    x-authentication:
      style: api-key
      header: Authorization
      format: 'Authorization: <STEDI_API_KEY>'
      legacy_format: 'Authorization: Key <STEDI_API_KEY>'
      oauth_on_rest: false
      detail: authentication/stedi-authentication.yml
- target: $.info
  update:
    x-conventions:
      pagination:
        style: cursor
        request_parameter: page_token
        items_field: items
        cursor_field: next_page_token
      errors:
        envelope: '{error, message}'
        rfc9457: false
        detail: errors/stedi-problem-types.yml
      rate_limits:
        exhaustion_status: 429
        exhaustion_code: TOO_MANY_REQUESTS
        headers_published: false
        detail: rate-limits/stedi-rate-limits.yml
      versioning:
        scheme: dated-path-prefix
        detail: lifecycle/stedi-lifecycle.yml
      detail: conventions/stedi-conventions.yml
- target: $.info
  update:
    x-testing:
      mode_selector: API key type (Test vs Production) plus an account-level Test mode toggle
      separate_test_host: false
      detail: sandbox/stedi-sandbox.yml
- target: $.info
  update:
    x-events:
      asyncapi: asyncapi/stedi-event-destinations-asyncapi.yml
      signing: 'Standard Webhooks (HMAC-SHA256, webhook-signature: v1,{signature})'
      retry_intervals:
      - 5m
      - 30m
      - 2h
      - 8h
      - 24h
      - 48h
      retention: 30 days