Svix · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Svix Inbound API

2 actions 2 updates phrasing extends openapi/svix-inbound-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/app/{app_id}/inbound/rotate-url'].post

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 Inbound API
  version: 1.0.0
extends: openapi/svix-inbound-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/app/{app_id}/inbound/rotate-url'].post
  update:
    x-apievangelist-phrasing:
      intent: Rotate an application's inbound URL
      effect: destructive
      questions:
      - How do I get a new inbound URL for an application and kill the old one?
      - Does rotating an app's inbound URL invalidate the previous URL right away?
      instructions:
      - text: Rotate the inbound URL for application {app_id}.
        slots:
          app_id: path.app_id
      - text: Invalidate app {app_id}'s current inbound URL and issue a new one.
        slots:
          app_id: path.app_id
      method: generated
      generated: '2026-09-26'