Twilio · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio Verify Entities API

3 actions 3 updates phrasing extends openapi/twilio-entities-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 3

$.info
$.paths['/Services/{ServiceSid}/Entities'].get
$.paths['/Services/{ServiceSid}/Entities'].post

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 Verify Entities API
  version: 1.0.0
extends: openapi/twilio-entities-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: 2
- target: $.paths['/Services/{ServiceSid}/Entities'].get
  update:
    x-apievangelist-phrasing:
      intent: List end-user entities in a Verify service
      effect: read
      questions:
      - Which end users have been set up for TOTP or push authentication?
      - What entities exist in my Verify service?
      instructions:
      - text: List the entities in Verify service {service}.
        slots:
          service: path.ServiceSid
      - text: Show every end user registered in service {service}.
        slots:
          service: path.ServiceSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Services/{ServiceSid}/Entities'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an end-user entity for authentication
      effect: write
      questions:
      - How do I register an end user before enrolling them in TOTP or push?
      - Can I create an entity from my own user ID?
      instructions:
      - text: Create entity {identity} in Verify service {service}.
        slots:
          identity: requestBody.Identity
          service: path.ServiceSid
      - text: Register my user {identity} as a new entity on service {service}.
        slots:
          identity: requestBody.Identity
          service: path.ServiceSid
      method: generated
      generated: '2026-09-26'