Wistia · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Data Share Links API

5 actions 5 updates phrasing extends openapi/wistia-share-links-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 5

$.info
$.paths['/share_links/{identifier}'].get
$.paths['/medias/{mediaId}/share_link'].get
$.paths['/medias/{mediaId}/share_link'].put
$.paths['/medias/{mediaId}/share_link'].delete

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 Data Share Links API
  version: 1.0.0
extends: openapi/wistia-share-links-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: 4
- target: $.paths['/share_links/{identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Resolve a share link to its media
      effect: read
      questions:
      - Which video does a given /s/ share link point to?
      - How do I look up a share link from the slug in its URL?
      instructions:
      - text: Resolve share link {identifier}.
        slots:
          identifier: path.identifier
      - text: Tell me which media the share link {identifier} points to.
        slots:
          identifier: path.identifier
      method: generated
      generated: '2026-10-01'
- target: $.paths['/medias/{mediaId}/share_link'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a media's share link
      effect: read
      questions:
      - How do I get the share link for a video?
      - What happens if a media has no share link yet when I request it?
      instructions:
      - text: Get the share link for media {mediaId}.
        slots:
          mediaId: path.mediaId
      - text: Show me the shareable URL of video {mediaId}.
        slots:
          mediaId: path.mediaId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/medias/{mediaId}/share_link'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a media share link's visibility
      effect: write
      questions:
      - How do I change who can open a video's share link?
      - Can I set the visibility of a share link?
      instructions:
      - text: Set the share link visibility for media {mediaId} to {visibility}.
        slots:
          mediaId: path.mediaId
          visibility: requestBody.visibility
      - text: Make video {mediaId}'s share link {visibility}.
        slots:
          mediaId: path.mediaId
          visibility: requestBody.visibility
      method: generated
      generated: '2026-10-01'
- target: $.paths['/medias/{mediaId}/share_link'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke a media's share link
      effect: destructive
      questions:
      - How do I revoke a share link so the old URL stops working?
      - Can I get a fresh share URL after deleting the old one?
      instructions:
      - text: Delete the share link for media {mediaId}.
        slots:
          mediaId: path.mediaId
      - text: Revoke the shareable URL on video {mediaId}.
        slots:
          mediaId: path.mediaId
      method: generated
      generated: '2026-10-01'