Wistia · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Data Push Devices API

3 actions 3 updates phrasing extends openapi/wistia-push-devices-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/devices'].post

$.paths['/devices/{deviceToken}'].delete

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 Data Push Devices API
  version: 1.0.0
extends: openapi/wistia-push-devices-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/devices'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a device for push notifications
      effect: write
      questions:
      - How do I register a device to get push notifications about comments and views?
      - Which APNs environment do I specify when registering a device token?
      instructions:
      - text: Register device token {device_token} for app {bundle_id} in {environment}.
        slots:
          device_token: requestBody.device_token
          bundle_id: requestBody.bundle_id
          environment: requestBody.environment
      - text: Enable push notifications for device {device_token}, bundle {bundle_id}, environment {environment}.
        slots:
          device_token: requestBody.device_token
          bundle_id: requestBody.bundle_id
          environment: requestBody.environment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/devices/{deviceToken}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unregister a push notification device
      effect: destructive
      questions:
      - How do I stop push notifications going to a device?
      - Can I unregister a device token I registered earlier?
      instructions:
      - text: Unregister device {deviceToken}.
        slots:
          deviceToken: path.deviceToken
      - text: Stop sending notifications to device token {deviceToken}.
        slots:
          deviceToken: path.deviceToken
      method: generated
      generated: '2026-10-01'