# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Millicast Subscribe Token V1 API
  version: 1.0.0
extends: openapi/dolby-subscribetokenv1-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: 6
- target: $.paths['/api/subscribe_token/{tokenId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a subscribe token
      effect: read
      questions:
      - What streams and restrictions does a subscribe token have?
      - Can I look up a viewer subscribe token by its ID?
      instructions:
      - text: Read subscribe token {token_id}.
        slots:
          token_id: path.tokenId
      - text: Show the streams allowed by subscribe token {token_id}.
        slots:
          token_id: path.tokenId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/subscribe_token/{tokenId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a subscribe token
      effect: write
      questions:
      - How do I add another stream to an existing subscribe token?
      - Can I deactivate a subscribe token or restrict it to certain countries?
      - Is it possible to regenerate the token value on a subscribe token?
      instructions:
      - text: Add streams {add_token_streams} to subscribe token {token_id}.
        slots:
          add_token_streams: requestBody.addTokenStreams
          token_id: path.tokenId
      - text: Set subscribe token {token_id} active to {is_active}.
        slots:
          token_id: path.tokenId
          is_active: requestBody.isActive
      - text: Restrict subscribe token {token_id} to countries {allowed_countries}.
        slots:
          token_id: path.tokenId
          allowed_countries: requestBody.updateAllowedCountries
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/subscribe_token/{tokenId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a subscribe token
      effect: destructive
      questions:
      - How do I revoke a viewer's subscribe token for good?
      - Where do I find the ID needed to delete a subscribe token?
      instructions:
      - text: Delete subscribe token {token_id}.
        slots:
          token_id: path.tokenId
      - text: Permanently revoke subscribe token {token_id}.
        slots:
          token_id: path.tokenId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/subscribe_token/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List subscribe tokens
      effect: read
      questions:
      - Which subscribe tokens exist on my account?
      - Can I sort and page through all subscribe tokens?
      instructions:
      - text: List subscribe tokens, page {page}, {items_on_page} per page.
        slots:
          page: query.page
          items_on_page: query.itemsOnPage
      - text: Show all subscribe tokens sorted by {sort_by}, page {page} of {items_on_page}.
        slots:
          sort_by: query.sortBy
          page: query.page
          items_on_page: query.itemsOnPage
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/subscribe_token/list_by_name'].get
  update:
    x-apievangelist-phrasing:
      intent: Find subscribe tokens by label or stream
      effect: read
      questions:
      - Which subscribe tokens grant access to a particular stream name?
      - Can I search subscribe tokens by their label?
      - Why don't wildcard tokens show up when I search by name?
      instructions:
      - text: Find subscribe tokens matching {name}, page {page}, {items_on_page} per page.
        slots:
          name: query.name
          page: query.page
          items_on_page: query.itemsOnPage
      - text: Search subscribe tokens where {filter_by} matches {name}, page {page} of {items_on_page}.
        slots:
          filter_by: query.filterBy
          name: query.name
          page: query.page
          items_on_page: query.itemsOnPage
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/subscribe_token'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a subscribe token for viewers
      effect: write
      questions:
      - How do I create a token so viewers can watch a secure stream?
      - Can a subscribe token expire or be limited to certain IPs or origins?
      instructions:
      - text: Create subscribe token {label} for streams {streams}.
        slots:
          label: requestBody.label
          streams: requestBody.streams
      - text: Create subscribe token {label} for {streams} that expires {expires}.
        slots:
          label: requestBody.label
          streams: requestBody.streams
          expires: requestBody.expires
      method: generated
      generated: '2026-10-01'