Wistia · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Custom Metadata Field Values API

5 actions 5 updates phrasing extends openapi/wistia-custom-metadata-field-values-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['/medias/{mediaHashedId}/custom_metadata_field_values'].get
$.paths['/medias/{mediaHashedId}/custom_metadata_field_values/{key}'].get
$.paths['/medias/{mediaHashedId}/custom_metadata_field_values/{key}'].put
$.paths['/medias/{mediaHashedId}/custom_metadata_field_values/{key}'].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 Custom Metadata Field Values API
  version: 1.0.0
extends: openapi/wistia-custom-metadata-field-values-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['/medias/{mediaHashedId}/custom_metadata_field_values'].get
  update:
    x-apievangelist-phrasing:
      intent: List a media's custom metadata values
      effect: read
      questions:
      - What custom metadata values are set on this video?
      - How do I see every metadata field value for one media at once?
      instructions:
      - text: List the custom metadata values on media {mediaHashedId}.
        slots:
          mediaHashedId: path.mediaHashedId
      - text: Show all metadata field values set for video {mediaHashedId}.
        slots:
          mediaHashedId: path.mediaHashedId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/medias/{mediaHashedId}/custom_metadata_field_values/{key}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one custom metadata value on a media
      effect: read
      questions:
      - How do I read a single custom metadata field's value on a video?
      - Can I look up one metadata value by its field key?
      instructions:
      - text: Get the value of metadata field {key} on media {mediaHashedId}.
        slots:
          key: path.key
          mediaHashedId: path.mediaHashedId
      - text: What is {key} set to for video {mediaHashedId}.
        slots:
          key: path.key
          mediaHashedId: path.mediaHashedId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/medias/{mediaHashedId}/custom_metadata_field_values/{key}'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a custom metadata value on a media
      effect: write
      questions:
      - How do I set or replace a custom metadata value on a video?
      - Can I tag a media with a value for one of my custom fields?
      instructions:
      - text: Set metadata field {key} on media {mediaHashedId} to {value}.
        slots:
          key: path.key
          mediaHashedId: path.mediaHashedId
          value: requestBody.value
      - text: Replace the {key} value on video {mediaHashedId} with {value}.
        slots:
          key: path.key
          mediaHashedId: path.mediaHashedId
          value: requestBody.value
      method: generated
      generated: '2026-10-01'
- target: $.paths['/medias/{mediaHashedId}/custom_metadata_field_values/{key}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Clear a custom metadata value on a media
      effect: destructive
      questions:
      - How do I blank out a custom metadata value on a video?
      - What happens if I clear a metadata field that has no value set?
      instructions:
      - text: Clear metadata field {key} on media {mediaHashedId}.
        slots:
          key: path.key
          mediaHashedId: path.mediaHashedId
      - text: Remove the {key} value from video {mediaHashedId}.
        slots:
          key: path.key
          mediaHashedId: path.mediaHashedId
      method: generated
      generated: '2026-10-01'