# 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 Definitions API
  version: 1.0.0
extends: openapi/wistia-custom-metadata-field-definitions-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['/custom_metadata_field_definitions'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom metadata field definitions
      effect: read
      questions:
      - What custom metadata fields are defined in my Wistia account?
      - Can I include archived field definitions in the list?
      instructions:
      - text: List my custom metadata field definitions.
      - text: List all custom metadata fields with include_archived set to {include_archived}.
        slots:
          include_archived: query.include_archived
      method: generated
      generated: '2026-10-01'
- target: $.paths['/custom_metadata_field_definitions'].post
  update:
    x-apievangelist-phrasing:
      intent: Define a new custom metadata field
      effect: write
      questions:
      - How do I add a new custom metadata field for my videos?
      - What characters are allowed in a custom metadata field key?
      instructions:
      - text: Create a custom metadata field with key {key}, label {label} and type {field_type}.
        slots:
          key: requestBody.key
          label: requestBody.label
          field_type: requestBody.field_type
      - text: Define a {field_type} metadata field {key} labelled {label} defaulting to {default_value}.
        slots:
          field_type: requestBody.field_type
          key: requestBody.key
          label: requestBody.label
          default_value: requestBody.default_value
      method: generated
      generated: '2026-10-01'
- target: $.paths['/custom_metadata_field_definitions/{key}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show a custom metadata field definition
      effect: read
      questions:
      - How do I see the type and options of one custom metadata field?
      - Is the field definition lookup by key case-sensitive?
      instructions:
      - text: Show the custom metadata field definition {key}.
        slots:
          key: path.key
      - text: Get the label and type of metadata field {key}.
        slots:
          key: path.key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/custom_metadata_field_definitions/{key}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a custom metadata field definition
      effect: write
      questions:
      - Can I relabel a custom metadata field without changing its key?
      - How do I change the display order of a metadata field definition?
      instructions:
      - text: Relabel metadata field {key} to {label}.
        slots:
          key: path.key
          label: requestBody.label
      - text: Move metadata field {key} to position {position}.
        slots:
          key: path.key
          position: requestBody.position
      method: generated
      generated: '2026-10-01'
- target: $.paths['/custom_metadata_field_definitions/{key}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Archive a custom metadata field definition
      effect: destructive
      questions:
      - How do I retire a custom metadata field I no longer use?
      - Is archiving a metadata field reversible?
      instructions:
      - text: Archive custom metadata field {key}.
        slots:
          key: path.key
      - text: Soft-delete the metadata field definition {key}.
        slots:
          key: path.key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/custom_metadata_field_definitions/{key}/restore'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore an archived metadata field definition
      effect: write
      questions:
      - How do I bring back a custom metadata field I archived?
      - What happens if I restore a field that is already active?
      instructions:
      - text: Restore archived metadata field {key}.
        slots:
          key: path.key
      - text: Unarchive the custom metadata field definition {key}.
        slots:
          key: path.key
      method: generated
      generated: '2026-10-01'