Svix · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Svix Health API

2 actions 2 updates phrasing extends openapi/svix-health-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/health'].get

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Svix Health API
  version: 1.0.0
extends: openapi/svix-health-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/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the API server is up
      effect: read
      questions:
      - Is the Svix API up and running right now?
      - Can I ping a health endpoint before sending webhooks?
      instructions:
      - text: Check the API health.
      - text: Ping the server to confirm it's responding.
      method: generated
      generated: '2026-09-26'