Svix · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Svix Background Task API

3 actions 3 updates phrasing extends openapi/svix-background-task-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 3

$.info
$.paths['/api/v1/background-task'].get
$.paths['/api/v1/background-task/{task_id}'].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 Background Task API
  version: 1.0.0
extends: openapi/svix-background-task-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: 2
- target: $.paths['/api/v1/background-task'].get
  update:
    x-apievangelist-phrasing:
      intent: List recent background tasks
      effect: read
      questions:
      - Which background jobs has my account run in the last 90 days?
      - Can I list only background tasks that failed or are still running?
      instructions:
      - text: List my background tasks.
      - text: List background tasks with status {status}.
        slots:
          status: query.status
      - text: Show background tasks of type {task}.
        slots:
          task: query.task
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/background-task/{task_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a background task's status
      effect: read
      questions:
      - Has my export or expunge background task finished yet?
      - How do I get the result payload of a background task?
      instructions:
      - text: Get background task {task_id}.
        slots:
          task_id: path.task_id
      - text: Check whether task {task_id} has finished and show its result.
        slots:
          task_id: path.task_id
      method: generated
      generated: '2026-09-26'