Twilio · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio Video Composition Hooks API

6 actions 6 updates phrasing extends openapi/twilio-composition-hooks-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Twilio's API. It is a proposal applied on top of the contract, not a document Twilio publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/CompositionHooks'].get

$.paths['/CompositionHooks'].post

$.paths['/CompositionHooks/{CompositionHookSid}'].get

$.paths['/CompositionHooks/{CompositionHookSid}'].post

$.paths['/CompositionHooks/{CompositionHookSid}'].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 Twilio Video Composition Hooks API
  version: 1.0.0
extends: openapi/twilio-composition-hooks-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/CompositionHooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List composition hooks via the legacy endpoint
      effect: read
      questions:
      - Is there an unversioned endpoint that lists my composition hooks?
      - Can I list only enabled hooks from the older /CompositionHooks path?
      instructions:
      - text: List composition hooks from the legacy unversioned endpoint.
      - text: Show legacy-endpoint composition hooks where enabled is {enabled}.
        slots:
          enabled: query.Enabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/CompositionHooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a composition hook via the legacy endpoint
      effect: write
      questions:
      - Can I still create an auto-composition hook through the legacy unversioned endpoint?
      - Does the older create call accept a video layout and output format?
      instructions:
      - text: Create composition hook {friendly_name} through the legacy endpoint.
        slots:
          friendly_name: requestBody.FriendlyName
      - text: Use the unversioned endpoint to add hook {friendly_name} producing {format} at {resolution}.
        slots:
          friendly_name: requestBody.FriendlyName
          format: requestBody.Format
          resolution: requestBody.Resolution
      method: generated
      generated: '2026-09-26'
- target: $.paths['/CompositionHooks/{CompositionHookSid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a composition hook via the legacy endpoint
      effect: read
      questions:
      - Can I fetch a composition hook from the older unversioned path?
      - Does the legacy endpoint still return a single hook by its SID?
      instructions:
      - text: Fetch composition hook {composition_hook_sid} from the legacy endpoint.
        slots:
          composition_hook_sid: path.CompositionHookSid
      - text: Show hook {composition_hook_sid} using the unversioned /CompositionHooks path.
        slots:
          composition_hook_sid: path.CompositionHookSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/CompositionHooks/{CompositionHookSid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a composition hook via the legacy endpoint
      effect: write
      questions:
      - Can I edit a composition hook through the legacy unversioned endpoint?
      - Does the older update call let me disable a hook while keeping its name?
      instructions:
      - text: Update legacy-endpoint hook {composition_hook_sid} to name {friendly_name} and enabled {enabled}.
        slots:
          composition_hook_sid: path.CompositionHookSid
          friendly_name: requestBody.FriendlyName
          enabled: requestBody.Enabled
      - text: Via the unversioned path, set hook {composition_hook_sid} named {friendly_name} to callback {status_callback}.
        slots:
          composition_hook_sid: path.CompositionHookSid
          friendly_name: requestBody.FriendlyName
          status_callback: requestBody.StatusCallback
      method: generated
      generated: '2026-09-26'
- target: $.paths['/CompositionHooks/{CompositionHookSid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a composition hook via the legacy endpoint
      effect: destructive
      questions:
      - Can I delete a composition hook through the older unversioned path?
      - Is the legacy delete call still available for composition hooks?
      instructions:
      - text: Delete composition hook {composition_hook_sid} through the legacy endpoint.
        slots:
          composition_hook_sid: path.CompositionHookSid
      - text: Remove hook {composition_hook_sid} using the unversioned /CompositionHooks path.
        slots:
          composition_hook_sid: path.CompositionHookSid
      method: generated
      generated: '2026-09-26'