Wistia · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Wistia Allowed Domains API

9 actions 9 updates phrasing extends openapi/wistia-allowed-domains-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 9

$.info

$.paths['/allowed_domains'].get

$.paths['/allowed_domains'].post

$.paths['/allowed_domains/{domain}'].get

$.paths['/allowed_domains/{domain}'].delete

$.paths['/allowed-domains'].get

$.paths['/allowed-domains'].post

$.paths['/allowed-domains/{domain}'].get

$.paths['/allowed-domains/{domain}'].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 Wistia Allowed Domains API
  version: 1.0.0
extends: openapi/wistia-allowed-domains-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: 8
- target: $.paths['/allowed_domains'].get
  update:
    x-apievangelist-phrasing:
      intent: List allowed embed domains
      effect: read
      questions:
      - Can I page through and sort my account's allowed domains?
      - What websites are currently permitted to play my embeds?
      instructions:
      - text: List my allowed domains sorted by {sort_by}.
        slots:
          sort_by: query.sort_by
      - text: Page through the allowed domains on my account, {per_page} at a time.
        slots:
          per_page: query.per_page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/allowed_domains'].post
  update:
    x-apievangelist-phrasing:
      intent: Permit a domain to embed my media
      effect: write
      questions:
      - Can I permit a specific website to show my videos?
      - What's needed to put a domain on my allowed list?
      instructions:
      - text: Add {domain} as an allowed domain.
        slots:
          domain: requestBody.domain
      - text: Permit {domain} to embed my media.
        slots:
          domain: requestBody.domain
      method: generated
      generated: '2026-10-01'
- target: $.paths['/allowed_domains/{domain}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one allowed domain
      effect: read
      questions:
      - Is a specific website currently permitted on my allowed-domains list?
      - What details does Wistia keep for one allowed domain?
      instructions:
      - text: Show the details of allowed domain {domain}.
        slots:
          domain: path.domain
      - text: Look up {domain} in my allowed domains.
        slots:
          domain: path.domain
      method: generated
      generated: '2026-10-01'
- target: $.paths['/allowed_domains/{domain}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke an allowed domain
      effect: destructive
      questions:
      - Can I revoke a website's permission to play my embeds?
      - Is there a way to delete one entry from my allowed domains list?
      instructions:
      - text: Revoke allowed domain {domain}.
        slots:
          domain: path.domain
      - text: Take {domain} off the allowed domains list.
        slots:
          domain: path.domain
      method: generated
      generated: '2026-10-01'
- target: $.paths['/allowed-domains'].get
  update:
    x-apievangelist-phrasing:
      intent: List allowed domains
      effect: read
      questions:
      - Which domains are allowed to embed my videos?
      - Can I see every domain on my embed allowlist?
      instructions:
      - text: List all allowed domains on my account.
      - text: Show the domains my videos are allowed to play on.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/allowed-domains'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an allowed domain
      effect: write
      questions:
      - How do I restrict my videos so they only play on my own website?
      - Can I add a new domain to the embed allowlist?
      instructions:
      - text: Add a new allowed domain to my account.
      - text: Allow another website domain to embed my videos.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/allowed-domains/{domain}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show one allowed domain
      effect: read
      questions:
      - Is a particular domain already on my embed allowlist?
      - What details are stored for a single allowed domain?
      instructions:
      - text: Show the allowed domain {domain}.
        slots:
          domain: path.domain
      - text: Check whether {domain} is on my allowlist.
        slots:
          domain: path.domain
      method: generated
      generated: '2026-10-01'
- target: $.paths['/allowed-domains/{domain}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an allowed domain
      effect: destructive
      questions:
      - How do I stop a website from embedding my videos?
      - Can I take a domain off my allowlist?
      instructions:
      - text: Remove {domain} from my allowed domains.
        slots:
          domain: path.domain
      - text: Delete the allowed domain {domain}.
        slots:
          domain: path.domain
      method: generated
      generated: '2026-10-01'