Twilio · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio - Microvisor Devices API

14 actions 14 updates phrasing extends openapi/twilio-devices-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 14

$.info
$.paths['/v1/Devices'].get
$.paths['/v1/Devices/{Sid}'].get
$.paths['/v1/Devices/{Sid}'].post
$.paths['/v1/Devices/{DeviceSid}/Configs'].get
$.paths['/v1/Devices/{DeviceSid}/Configs'].post
$.paths['/v1/Devices/{DeviceSid}/Configs/{Key}'].get
$.paths['/v1/Devices/{DeviceSid}/Configs/{Key}'].post
$.paths['/v1/Devices/{DeviceSid}/Configs/{Key}'].delete
$.paths['/v1/Devices/{DeviceSid}/Secrets'].get
$.paths['/v1/Devices/{DeviceSid}/Secrets'].post
$.paths['/v1/Devices/{DeviceSid}/Secrets/{Key}'].get
$.paths['/v1/Devices/{DeviceSid}/Secrets/{Key}'].post
$.paths['/v1/Devices/{DeviceSid}/Secrets/{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 Twilio - Microvisor Devices API
  version: 1.0.0
extends: openapi/twilio-devices-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: 13
- target: $.paths['/v1/Devices'].get
  update:
    x-apievangelist-phrasing:
      intent: List my Microvisor devices
      effect: read
      questions:
      - Which Microvisor devices are registered to my account?
      - What IoT devices do I have enrolled right now?
      instructions:
      - text: List all my registered devices.
      - text: Show my Microvisor devices, {page_size} per page.
        slots:
          page_size: query.PageSize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Devices/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one Microvisor device
      effect: read
      questions:
      - Which app is targeted to a specific device, and is logging on?
      - Can I look up a single device by its SID?
      instructions:
      - text: Get device {device}.
        slots:
          device: path.Sid
      - text: Show the details and target app for device {device}.
        slots:
          device: path.Sid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Devices/{Sid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update, retarget or restart a device
      effect: write
      questions:
      - How do I deploy a different app to one of my Microvisor devices?
      - Can I restart the app running on a device remotely?
      - Is there a way to turn on application logging for a device for 24 hours?
      instructions:
      - text: Target app {app} to device {device}.
        slots:
          app: requestBody.TargetApp
          device: path.Sid
      - text: Restart the app on device {device} by setting restart to {restart}.
        slots:
          device: path.Sid
          restart: requestBody.RestartApp
      - text: Give device {device} the unique name {unique_name}.
        slots:
          device: path.Sid
          unique_name: requestBody.UniqueName
      - text: Set application logging on device {device} to {logging}.
        slots:
          device: path.Sid
          logging: requestBody.LoggingEnabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Devices/{DeviceSid}/Configs'].get
  update:
    x-apievangelist-phrasing:
      intent: List a device's config values
      effect: read
      questions:
      - Which configuration keys are set on a Microvisor device?
      - What non-secret settings has a device been given?
      instructions:
      - text: List all configs for device {device}.
        slots:
          device: path.DeviceSid
      - text: Show the configuration keys on device {device}, {page_size} per page.
        slots:
          device: path.DeviceSid
          page_size: query.PageSize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Devices/{DeviceSid}/Configs'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a config value to a device
      effect: write
      questions:
      - How do I push a new configuration setting to a Microvisor device?
      - Can I store a plain key/value config on a single device?
      instructions:
      - text: Add config {key} with value {value} to device {device}.
        slots:
          key: requestBody.Key
          value: requestBody.Value
          device: path.DeviceSid
      - text: Create a new setting {key} = {value} on device {device}.
        slots:
          key: requestBody.Key
          value: requestBody.Value
          device: path.DeviceSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Devices/{DeviceSid}/Configs/{Key}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read one config value on a device
      effect: read
      questions:
      - What value does a particular config key currently have on my device?
      - Can I read back a single device configuration setting?
      instructions:
      - text: Get config {key} from device {device}.
        slots:
          key: path.Key
          device: path.DeviceSid
      - text: Read the current value of setting {key} on device {device}.
        slots:
          key: path.Key
          device: path.DeviceSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Devices/{DeviceSid}/Configs/{Key}'].post
  update:
    x-apievangelist-phrasing:
      intent: Change a config value on a device
      effect: write
      questions:
      - How do I change an existing configuration value on a Microvisor device?
      - Can I overwrite a device setting that is already set?
      instructions:
      - text: Update config {key} on device {device} to {value}.
        slots:
          key: path.Key
          device: path.DeviceSid
          value: requestBody.Value
      - text: Overwrite existing setting {key} of device {device} with {value}.
        slots:
          key: path.Key
          device: path.DeviceSid
          value: requestBody.Value
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Devices/{DeviceSid}/Configs/{Key}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a config value from a device
      effect: destructive
      questions:
      - Can I remove a configuration key from a device?
      - What if a device config setting is obsolete and needs deleting?
      instructions:
      - text: Delete config {key} from device {device}.
        slots:
          key: path.Key
          device: path.DeviceSid
      - text: Remove setting {key} from device {device} entirely.
        slots:
          key: path.Key
          device: path.DeviceSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Devices/{DeviceSid}/Secrets'].get
  update:
    x-apievangelist-phrasing:
      intent: List the secrets stored on a device
      effect: read
      questions:
      - Which secrets have been stored for a Microvisor device?
      - What secret keys does a device have, such as API tokens or passwords?
      instructions:
      - text: List all secrets for device {device}.
        slots:
          device: path.DeviceSid
      - text: Show the secret keys on device {device}, {page_size} per page.
        slots:
          device: path.DeviceSid
          page_size: query.PageSize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Devices/{DeviceSid}/Secrets'].post
  update:
    x-apievangelist-phrasing:
      intent: Store a secret on a device
      effect: write
      questions:
      - How do I give a Microvisor device a credential without baking it into the app?
      - Can I store a secret like a password on one device?
      instructions:
      - text: Store secret {key} with value {value} on device {device}.
        slots:
          key: requestBody.Key
          value: requestBody.Value
          device: path.DeviceSid
      - text: Create a new secret {key} for device {device} holding {value}.
        slots:
          key: requestBody.Key
          device: path.DeviceSid
          value: requestBody.Value
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Devices/{DeviceSid}/Secrets/{Key}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one secret on a device
      effect: read
      questions:
      - Does a device have a particular secret key set?
      - Can I retrieve the record of one secret stored for a device?
      instructions:
      - text: Get secret {key} for device {device}.
        slots:
          key: path.Key
          device: path.DeviceSid
      - text: Look up the secret named {key} on device {device}.
        slots:
          key: path.Key
          device: path.DeviceSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Devices/{DeviceSid}/Secrets/{Key}'].post
  update:
    x-apievangelist-phrasing:
      intent: Rotate a secret on a device
      effect: write
      questions:
      - How do I rotate a password or token already stored as a device secret?
      - Can I replace the value of an existing device secret?
      instructions:
      - text: Update secret {key} on device {device} to {value}.
        slots:
          key: path.Key
          device: path.DeviceSid
          value: requestBody.Value
      - text: Rotate existing secret {key} of device {device} to the new value {value}.
        slots:
          key: path.Key
          device: path.DeviceSid
          value: requestBody.Value
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Devices/{DeviceSid}/Secrets/{Key}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a secret from a device
      effect: destructive
      questions:
      - Can I remove a secret from a device once it is no longer needed?
      - What if a device secret has leaked and should be deleted?
      instructions:
      - text: Delete secret {key} from device {device}.
        slots:
          key: path.Key
          device: path.DeviceSid
      - text: Remove the stored secret {key} from device {device}.
        slots:
          key: path.Key
          device: path.DeviceSid
      method: generated
      generated: '2026-09-26'