Twilio · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio - Voice Ip Records API

6 actions 6 updates phrasing extends openapi/twilio-iprecords-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['/v1/IpRecords'].get

$.paths['/v1/IpRecords'].post

$.paths['/v1/IpRecords/{Sid}'].get

$.paths['/v1/IpRecords/{Sid}'].post

$.paths['/v1/IpRecords/{Sid}'].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 - Voice Ip Records API
  version: 1.0.0
extends: openapi/twilio-iprecords-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['/v1/IpRecords'].get
  update:
    x-apievangelist-phrasing:
      intent: List registered IP records
      effect: read
      questions:
      - Which IP addresses have I registered with my account?
      - Can I see all my IP records and their CIDR ranges?
      instructions:
      - text: List all my IP records.
      - text: Show every registered IP address and its prefix length.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/IpRecords'].post
  update:
    x-apievangelist-phrasing:
      intent: Register an IP address or range
      effect: write
      questions:
      - How do I register an IPv4 address or CIDR block with Twilio?
      - Is IPv6 supported when adding an IP record?
      instructions:
      - text: Register IP address {ip}.
        slots:
          ip: requestBody.IpAddress
      - text: Add IP record {ip}/{prefix} named {name}.
        slots:
          ip: requestBody.IpAddress
          prefix: requestBody.CidrPrefixLength
          name: requestBody.FriendlyName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/IpRecords/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one IP record
      effect: read
      questions:
      - What address and range does a specific IP record cover?
      - Can I check the name I gave one registered IP?
      instructions:
      - text: Show IP record {record}.
        slots:
          record: path.Sid
      - text: Get the address and CIDR length of record {record}.
        slots:
          record: path.Sid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/IpRecords/{Sid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Rename an IP record
      effect: write
      questions:
      - Can I change the label on an IP record without re-registering the address?
      - Is the friendly name the only thing I can edit on an existing IP record?
      instructions:
      - text: Rename IP record {record} to {name}.
        slots:
          record: path.Sid
          name: requestBody.FriendlyName
      - text: Update the description on existing IP record {record}.
        slots:
          record: path.Sid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/IpRecords/{Sid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an IP record
      effect: destructive
      questions:
      - How do I unregister an IP address we no longer use?
      - What happens when I delete a registered IP record?
      instructions:
      - text: Delete IP record {record}.
        slots:
          record: path.Sid
      - text: Unregister the IP range in record {record}.
        slots:
          record: path.Sid
      method: generated
      generated: '2026-09-26'