Svix · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Svix Events API

2 actions 2 updates phrasing extends openapi/svix-events-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Svix's API. It is a proposal applied on top of the contract, not a document Svix publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/api/v1/events'].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 Svix Events API
  version: 1.0.0
extends: openapi/svix-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: 1
- target: $.paths['/api/v1/events'].get
  update:
    x-apievangelist-phrasing:
      intent: Read the operational events stream
      effect: read
      questions:
      - How can I poll the operational webhook events for my environment instead of receiving them?
      - Can I read only certain operational event types, like endpoint failures?
      - What operational events happened after a given point in time?
      instructions:
      - text: Read the latest operational events for this environment.
      - text: Fetch operational events of types {event_types} after {after}.
        slots:
          event_types: query.event_types
          after: query.after
      - text: Continue reading the operational event stream from iterator {iterator}, {limit} at a time.
        slots:
          iterator: query.iterator
          limit: query.limit
      method: generated
      generated: '2026-09-26'